aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md57
1 files changed, 57 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..9105f9b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,57 @@
+# Concise
+
+一个简约的Hugo主题。专注于写作。
+
+## Features
+
+- 极致简约设计
+- 无多余功能
+- 回归博客本质
+
+## Quickstart
+
+```bash
+git clone https://github.com/yingyu5658/hugo-theme-concise.git themes/concise
+```
+
+在站点根目录`hugo.toml`中填入以下配置:
+
+```toml
+baseURL = "..."
+publishDir = "public"
+title = "YOUR_WEBSITE_TITLE"
+description = "SUBTITLE"
+languageCode = "zh-CN"
+theme = ["concise"]
+pagination = { pagerSize = 25 }
+
+[permalinks]
+posts = "YOUR_PERMALINKS"
+
+[params]
+[[params.homepage.content]]
+name = "文章归档"
+url = "/post"
+
+[[params.homepage.content]]
+name = "友情链接"
+url = "/links"
+
+[[params.homepage.content]]
+name = "关于"
+url = "/about"
+
+[[params.homepage.content]]
+name = "RSS"
+url = "/atom.xml"
+
+[params.footer]
+content = "Email: YOUR_EMAIL"
+
+[markup.highlight]
+noClasses = true
+style = "emacs" #github、emacs、solarized-light 等
+
+[outputFormats.RSS]
+ baseName = "atom"
+```