docs: explain config options (#13)

1 files changed, 79 insertions, 0 deletions

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"