From 4684fca2c8817b1baf2c2be7ff3993b2080a62a1 Mon Sep 17 00:00:00 2001
From: WayJam So <imsuwj@gmail.com>
Date: Sun, 3 May 2020 20:29:11 +0800
Subject: Initial

---
 README.md | 58 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 58 insertions(+)
 create mode 100644 README.md

(limited to 'README.md')

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..38895f9
--- /dev/null
+++ b/README.md
@@ -0,0 +1,58 @@
+# Mixedpaper for Hugo
+
+Mixedpaper is a minimalist Hugo theme for writers and bloggers.
+
+## Feature
+
+- Clean and minimalist
+- SCSS styling
+- JavaScript free
+- Syntax highlighting
+
+## Installation
+
+Navigate to the root directory of your Hugo site and clone this repository.
+
+Refer to the [Hugo docs](https://gohugo.io/getting-started/quick-start/) for more information.
+
+## Configuration
+
+#### Hightlight
+
+To enable theme-defined highlighting style, please set `pygmentsUseClasses = true` in `config.toml`
+
+#### Archives
+
+```toml
+[[menu.main]]
+	name = "Archives"
+	identifier = "archives"
+	url = "/archives/"
+```
+
+#### Comments
+
+Supported Disqus and Valine now.
+
+```toml
+[params.comment]
+type = "disqus" # or valine
+[params.comment.valine]
+appid = "appid"
+appkey = "appkey"
+notify = "notify"
+verify = "verify"
+placeholder = "enjoy~"
+avatar = "mm"
+meta = "nick,mail"
+pageSize = 10.0
+visitor = false
+```
+
+#### More
+
+Refer to `exampleSite/config.toml` for more example.
+
+## License
+
+Released under the [MIT License](https://github.com/wayjam/hugo-theme-mixedpaper/blob/master/LICENSE.md).
-- 
cgit v1.2.3