diff options
author | jesselau76 <jesselau76@gmail.com> | 2018-11-26 01:15:36 +0300 |
---|---|---|
committer | jesselau76 <jesselau76@gmail.com> | 2018-11-26 01:15:36 +0300 |
commit | 210fd3cd1b83b513bf59ce7aac1c23fa9927c008 (patch) | |
tree | e0a141f8bb850f390e8e02057bcb03faaef7789e | |
parent | 802db94b4ffdfdf141a01bf2e475f79f645223b4 (diff) |
Chinese version readme
-rw-r--r-- | README-zh.md | 93 | ||||
-rw-r--r-- | README.md | 5 | ||||
-rw-r--r-- | theme.toml | 2 |
3 files changed, 97 insertions, 3 deletions
diff --git a/README-zh.md b/README-zh.md new file mode 100644 index 0000000..1acdd8a --- /dev/null +++ b/README-zh.md @@ -0,0 +1,93 @@ + + + + + + +# Hugo W3 SIMPLE + + +**Hugo W3 Simple** 由 [Jesse Lau](https://jesselau.com)创作。根由原本打算做一个极简化的基于W3 CSS的Wordpress模板,却无意中搜索到了HUGO,从而被HUGO圈粉,转Wordpress到HUGO,顺便做了这个模板,并逐步改进。 + + +## 主要特点: + + - 采用W3.css - 同类CSS框架文件最小的,最小故最快。 + - 自适应移动设备 + - W3 code color js - 也是小而快的代码高亮模块。 + - Twitter Card + - Google Analytics + - Disqus评论系统 + - One Signal Push + - 书签及共享按钮条,大屏幕时常位于左侧,中小屏幕位于帖子下方。 + - 当前版本四种快捷方式:Info, Warning, Colorcode, quote. [演示](https://jesselau.com/hugo-w3-simple-shortcodes-demo/ + - Sphinx 或者Manticore search全文本搜索支持. 直接生成可被Sphinx 或者Manticore search检索的XML文件。[运行演示](https://jesselau.com/search/) + - 滑屏时自动显示文章目录、进度条指示和回到顶端按钮 + - 网格化风格和极简化风格可切换。 + - 全部帖子可集中与一页,并带表格排序、标题过滤功能. [运行演示](https://jesselau.com/allposts/) + - Google翻译. + - 社交按钮. + - 支持多语言. + - 辉光式LOGO,可选 + + ## 屏幕截图 +### 网格化风格 +![HUGO W3 SIMPLE](https://raw.githubusercontent.com/jesselau76/hugo-w3-simple/master/images/tn.png) +### 极简化风格 + +![HUGO W3 SIMPLE DEVICE](https://raw.githubusercontent.com/jesselau76/hugo-w3-simple/master/images/device.png) + + ### 全部帖子在一页,有根据帖子发布时间、字数统计排序 + +![HUGO W3 SIMPLE all posts](https://raw.githubusercontent.com/jesselau76/hugo-w3-simple/master/images/allposts.png) + + +## 安装: + ```bash + cd themes + git clone https://github.com/jesselau76/hugo-w3-simple.git + ``` + +## 如何配置? +请将examplesite的 **config. toml** 文件拷贝并参照配置。 + + +## 多语言站点 +Hugo W3 Simple支持多语言站点. example site目录包括了英文和中文两者。可参照examplesite的 **config. toml** 文件配置 + +## 搜索功能 + +如果要用sphinx或manticoresearch来实现站内搜索功能。需要建立一个 `./content/{langcode}/search/index.md` 文件。 + +**注意:**不建议服务器支持HTML文件运行PHP语言,为安全考虑,请将Hugo生成的search/index.html更名为index.php再上传服务器。 + +## 全部帖子页面 + +要生成全部帖子页面,需要创建 `./content/{langcode}/allposts/_index.md` 文件。可参照exampleSite内文件。 + + + +## 更新主题 + +本主题会经常更新,故此用下列命令可快速更新到最新版本 + +```bash +cd themes/hugo-w3-simple/ +git pull +``` + +## 版权 + +采用 [MIT](https://github.com/jesselau76/hugo-w3-simple/blob/master/LICENSE) License. + +## 致谢 +从下列主题中学到不少Hugo做主题的经验,特此致谢: + +- [Hugo Xmin](https://github.com/yihui/hugo-xmin) +- [Even](https://github.com/olOwOlo/hugo-theme-even) +- [Mediumish](https://github.com/lgaida/mediumish-gohugo-theme) + + + + + @@ -4,9 +4,10 @@ + # Hugo W3 SIMPLE -## _Keep it simple, but not simpler_ +[Demo](https://themes.gohugo.io/theme/hugo-w3-simple/) | [Live](https://jesselau.com/) | [中文说明](https://github.com/jesselau76/hugo-w3-simple/blob/master/README-zh.md) **Hugo W3 Simple** is a Hugo theme written by [Jesse Lau](https://jesselau.com) . The main motivation for writing this theme was to provide a really minimal theme with W3 CSS included. @@ -26,7 +27,7 @@ - Sphinx or Manticore search supported. Output xml file which can be indexed by sphinx and manticore search. Example site can not include search function because it need server-side setting. [Live Search function Demo Here](https://jesselau.com/search/) - Table of content and back to top button on scroll. - Grid style and simple list style. - - All posts in one page. With a filterable, sortable and responsive table powered by w3.js. [Live Demo Here.](https://jesselau.com/allposts/) + - All posts in one page. With a filterable, sortable and responsive table powered by w3.js. [Live Demo Here.](https://jesselau.com/en/allposts/) - Google translate. - Social icon. - Multilingual. @@ -6,7 +6,7 @@ license = "MIT" licenselink = "https://github.com/jesselau76/hugo-w3-simple/blob/master/LICENSE" description = "A simple theme for Hugo, powered by W3.css" homepage = "https://github.com/jesselau76/hugo-w3-simple" -tags = ["minimal", "blog", "search", "clean", "simple", "starter", "minimalist","Responsive", "Disqus", "font-awesome","syntax highlighting","Multilingual"] +tags = ["minimal", "blog", "search", "clean", "simple", "starter", "minimalist","Responsive", "Disqus", "font-awesome","syntax highlighting", "Multilingual", "Google Analytics"] features = ["blog", "syntax highlighting"] min_version = "0.41" |