docs: explain config options (#13)

6 files changed, 84 insertions, 61 deletions

diff --git a/Makefile b/Makefile
index 9d926f9..c4605b6 100644
--- a/Makefile
+++ b/Makefile
@@ -17,4 +17,3 @@ dev:
 	--contentDir="exampleSite/content" \
 	--disableFastRender \
 	--themesDir=".."
-
diff --git a/README.md b/README.md
index 5cc39b7..c607aca 100644
--- a/README.md
+++ b/README.md
@@ -18,7 +18,7 @@ Install with:
 
 ```bash
 git submodule add https://github.com/queensferryme/hugo-theme-texify.git themes/hugo-theme-texify
-cp themes/hugo-theme-texify/exampleSite/config.toml config.toml
+cp themes/hugo-theme-texify/config.toml config.toml
 ```
 
 Upgrade with:
@@ -27,7 +27,7 @@ Upgrade with:
 git submodule foreach git pull origin master
 ```
 
-See `exampleSite/config.toml` for an example configuration.
+See `config.toml` for an example configuration.
 
 Note that for Simplified Chinese users, it is generally recommended to use [Noto Serif SC](https://fonts.google.com/specimen/Noto+Serif+SC) via Google Fonts. For instance, put the following codes in your `static/css/custom.css`:
 
diff --git a/config.toml b/config.toml
new file mode 100644
index 0000000..d8bff0b
--- /dev/null
+++ b/config.toml
@@ -0,0 +1,79 @@
+###################################################
+# BUILT-IN CONFIGURATION OPTOINS                  #
+# https://gohugo.io/getting-started/configuration #
+###################################################
+
+baseURL = "https://texify.qufy.me" # website root path
+disqusShortname = ""               # Disqus shortcode
+enableRobotsTXT = true             # /robots.txt
+googleAnalytics = ""               # Google Analytics ID
+hasCJKLanguage = true              # Chinese/Japanese/Korean
+languageCode = "en"                # content language
+paginate = 5                       # number of posts each page
+rssLimit = 10                      # maximum items in rss feeds
+theme = "hugo-theme-texify"        # theme directory name
+title = "TeXify"                   # website title
+
+[author]
+email = "me@example.com" # your email
+name = "author"          # your name
+
+# https://gohugo.io/getting-started/configuration-markup
+[markup]
+defaultMarkdownHandler = "goldmark"
+[markup.goldmark.renderer]
+unsafe = true # enable html in markdown
+[markup.highlight]
+style = "emacs" # syntax highlight style, see https://xyproto.github.io/splash/docs/
+
+# https://gohugo.io/content-management/menus/
+[[menu.main]] # sections in the website header
+identifier = "post" # section id
+name = "Post"       # section display title
+url = "/"           # path to the section
+weight = 1          # order of sections
+[[menu.main]]
+identifier = "archives"
+name = "Archives"
+url = "/post/"
+weight = 2
+[[menu.main]]
+identifier = "about"
+name = "About"
+url = "/about/"
+weight = 3
+
+# https://gohugo.io/getting-started/configuration/#configure-minify
+[minify]
+minifyOutput = false # output asset minimization
+
+
+########################
+# TEXIFY THEME OPTIONS #
+########################
+
+[params]
+description = "an example site for hugo theme TeXify" # website description
+favicon = "/favicon.ico" # path to website icon
+footnote = """
+Follow me on <a class=link href=https://github.com/queensferryme>GitHub</a>,
+<a class=link href=https://twitter.com/queensferryme>Twitter</a> or
+<a class=link href=/index.xml>RSS</a> |
+<a class=link href=https://creativecommons.org/licenses/by-nc-sa/4.0/deed.zh target=_blank rel=noopener>CC BY-NC-SA 4.0</a>
+""" # notes in the website footer
+keywords = ["hugo", "latex", "theme"] # website keywords
+
+customCSS = [] # path to custom css files, relative to './static/css/'
+customJS = [] # path to custom js files, relative to './static/js/'
+dateFormat = "2006-01-02" # date format, see https://gohugo.io/functions/format/
+enableFullRSS = true # rss full-text output
+enableHanEmph = true # use dots to emphasize chinese texts, see https://zh.wikipedia.org/wiki/%E7%9D%80%E9%87%8D%E5%8F%B7
+enableMathjax = true # enable mathjax for rendering math formulas
+
+# https://utteranc.es
+[params.utterances]
+enable = false
+repo = ""
+issue_term = "pathname"
+label = "Comment"
+theme = "github-light"
diff --git a/exampleSite/config.toml b/exampleSite/config.toml
index 61fb123..e1fd6d8 100644..120000
--- a/exampleSite/config.toml
+++ b/exampleSite/config.toml
@@ -1,55 +1 @@
-baseURL = "https://texify.qufy.me"
-defaultContentLanguage = "en"
-hasCJKLanguage = true
-languageCode = "en"
-paginate = 5
-theme = "hugo-theme-texify"
-title = "TeXify"
-
-disqusShortname = ""
-googleAnalytics = ""
-pygmentsUseClasses = true
-
-[author]
-name = "author"
-
-[markup]
-  defaultMarkdownHandler = "goldmark"
-  [markup.goldmark]
-    [markup.goldmark.renderer]
-      unsafe = true
-
-[[menu.main]]
-  identifier = "post"
-  name = "Post"
-  url = "/"
-  weight = 1
-[[menu.main]]
-  identifier = "archives"
-  name = "Archives"
-  url = "/post/"
-  weight = 2
-[[menu.main]]
-  identifier = "about"
-  name = "About"
-  url = "/about/"
-  weight = 3
-
-[params]
-  customCSS = []
-  dateFormat = "2006-01-02"
-  description = "an example site for hugo theme TeXify"
-  enableFullRSS = true
-  enableHanEmph = true
-  enableMathjax = true
-  favicon = "/favicon.ico"
-  footnote = "Follow me on <a class=link href=https://github.com/queensferryme>GitHub</a>, <a class=link href=https://twitter.com/queensferryme>Twitter</a> or <a class=link href=/index.xml>RSS</a> | <a class=link href=https://creativecommons.org/licenses/by-nc-sa/4.0/deed.zh target=_blank rel=noopener>CC BY-NC-SA 4.0</a>"
-  keywords = ["hugo", "latex", "theme"]
-
-# see https://utteranc.es for installation guide
-[params.utterances]
-  enable = false
-  repo = ""
-  issue_term = "pathname"
-  label = "Comment"
-  theme = "github-light"
+../config.toml
\ No newline at end of file
diff --git a/exampleSite/content/post/emoji-support.md b/exampleSite/content/post/emoji-support.md
index dc3589a..f17f49a 100644
--- a/exampleSite/content/post/emoji-support.md
+++ b/exampleSite/content/post/emoji-support.md
@@ -8,9 +8,9 @@ tags = [
 ]
 +++
 
-Emoji can be enabled in a Hugo project in a number of ways. 
+Emoji can be enabled in a Hugo project in a number of ways.
 <!--more-->
-The [`emojify`](https://gohugo.io/functions/emojify/) function can be called directly in templates or [Inline Shortcodes](https://gohugo.io/templates/shortcode-templates/#inline-shortcodes). 
+The [`emojify`](https://gohugo.io/functions/emojify/) function can be called directly in templates or [Inline Shortcodes](https://gohugo.io/templates/shortcode-templates/#inline-shortcodes).
 
 To enable emoji globally, set `enableEmoji` to `true` in your site's [configuration](https://gohugo.io/getting-started/configuration/) and then you can type emoji shorthand codes directly in content files; e.g.
 
diff --git a/layouts/_default/rss.xml b/layouts/_default/rss.xml
index e228d88..5fe60fc 100644
--- a/layouts/_default/rss.xml
+++ b/layouts/_default/rss.xml
@@ -43,4 +43,3 @@
     {{ end }}
   </channel>
 </rss>
-