new version supporting for chinese

Author: li-xin-yi

.gitignore

@@ -115,3 +115,4 @@ dmypy.json
 
 .idea/
 *.DS_Store
+*/temp

README.md

@@ -23,6 +23,7 @@ It is a light and useful Python module, helping you generate a small size, prett
   * [Run a `Journalist()` in your code to fetch variables](#run-a--journalist----in-your-code-to-fetch-variables)
   * [Invite a journalist to make a big news report](#invite-a-journalist-to-make-a-big-news-report)
 - [I am too lazy to write a `md` template](#i-am-too-lazy-to-write-an--md--template)
+- [Support For zh_CN](#support-for-zh_cn)
 - [What will my variables on slides look like?](#what-will-my-variables-on-slides-look-like-)
 - [More examples and instructions](#more-examples-and-instructions)
 - [Tips](#tips)
@@ -146,6 +147,31 @@ Output ([raw file](./demo/auto_report.pdf) ):
 
 ![](./demo/auto_report.png)
 
+## Support For zh_CN
+
+Yes, now, from version 0.0.5, it can use template contains chinese characters :tada:.
+
+Just pass argument `zh=True` when creating a Journalist(), or set its `zh` property at any time before generating reports. 
+
+```py
+reporter = Journalist(template_file='./reports/template.md', zh=True)
+```
+
+If you want to use your customized template with chinese characters, don't forget to add one line at first of the YAML metadata block in your `Markdown` template:
+
+```markdown
+---
+documentclass: ctexbeamer
+...
+---
+```
+
+Here is a [simple example](./examples/3_zh_CN_support.py) similar to [Quick start](#quick-start), Except for [its template](./examples/reports/3_zh_cn_template.md) containing chinese characters. A perfect chinese [slides](./examples/reports/3_zh_report.pdf) file can be generated by the program as:
+
+![](./demo/zh_demo.png)
+
+**Note**: make sure `xelatex` is installed properly.
+
 ## What will my variables on slides look like?
 
 All variables pass to `Journalist` via `hear` will display as strings just like what their `__str__` method does.

demo/zh_big_news.pdf

@@ -0,0 +1,34 @@
+import numpy as np
+import pandas as pd
+import matplotlib.pyplot as plt
+from hkjournalist import Journalist
+
+config = {}
+
+
+def sin_2x_and_cos_2x(x):
+    y = np.sin(x) * np.sin(x) + np.cos(x) * np.cos(x)
+    return y
+
+
+x = np.arange(0, 4 * np.pi, 0.1)
+y1 = np.sin(x)
+y2 = np.cos(x)
+
+df = pd.DataFrame({'x': x, 'sin(x)': y1, 'cos(x)': y2})
+df['sin^2^(x)+cos^2^(x)'] = sin_2x_and_cos_2x(df['x']).values
+df = df.set_index('x')
+
+# plot sine curve as sin_plot
+ax = df.plot()
+plt.tight_layout()
+config['sin_plot'] = ax
+
+# random select 5 point (x,y) as sin_table
+config['sin_table'] = df.sample(5)
+
+config['sin_func'] = sin_2x_and_cos_2x
+
+reporter = Journalist(template_file='./reports/3_zh_cn_template.md', zh=True)
+reporter.hear(config)
+reporter.report(output_file='./reports/3_zh_report.pdf', beamer=True, overwrite=True)

demo/zh_demo.png

@@ -1,7 +1,8 @@
-% Report template 
-% Author
-% {today}
-
+---
+title: template
+author: Author
+date: \today{{}}
+---
 ### Cover_type
 
 {Cover_type}

examples/3_zh_CN_support.py

@@ -0,0 +1,22 @@
+---
+documentclass: ctexbeamer
+title: 中文报告
+author: 香港记者
+date: \today{{}}
+---
+
+### 正弦曲线
+
+![]({sin_plot})
+
+### 正弦取值
+
+{sin_table}
+
+### 正弦函数
+
+```{{.python}}
+{sin_func}
+```
+
+