diff --git a/README.md b/README.md index 804fa68..2717bf3 100644 --- a/README.md +++ b/README.md @@ -8,13 +8,14 @@ A Clean and minimal Hugo theme porting from the [Hexo Minima](https://github.com ## Features +- [x] Clean - [x] Light/dark mode -- [x] VSCode-style code hightlighting +- [x] VSCode-style code hightlighting (the most alike among all Hugo themes) - [x] KaTeX -- [x] Mermaid +- [x] Mermaid diagrams - [x] Google analytics -- [x] Disqus/Utterances comments -- [x] Optional ToC +- [x] Disqus/Utterances +- [x] Optional ToC ## Usage diff --git a/exampleSite/config.toml b/exampleSite/config.toml index 7b0adcc..7e5304b 100644 --- a/exampleSite/config.toml +++ b/exampleSite/config.toml @@ -1,7 +1,7 @@ baseURL = "http://h.xjj.pub" languageCode = "en-us" title = "Hi Folks" -copyright = "© XJJ 2021" +copyright = "© XJJ 2022" googleAnalytics = "" # paginate decides the number of the newest posts @@ -17,7 +17,7 @@ theme = "hugo-theme-minima" [author] name = "XJJ" slogon = "A tech lover from Earth 🌍" -description = "This is Minima, a clean and minimal Hugo theme porting from the [Hexo Minima](https://github.com/adisaktijrs/hexo-theme-minima). Except for everything from Hexo Minima like dark/light mode, it supports KaTeX, Mermaid, comments and some taxonomies like categories, series and tags. I created this using SCSS, Vanilla JS and the most important, Hugo. 😁" +description = "This is Minima, a clean and minimal Hugo theme porting from the [Hexo Minima](https://github.com/adisaktijrs/hexo-theme-minima). Except for everything from Hexo Minima like dark/light mode, Hugo Minima supports KaTeX, Mermaid, comments and some taxonomies like categories, series and tags. I created this using SASS, VanillaJS and the most importantly, Hugo. 😁" [params] @@ -63,8 +63,8 @@ issueTerm = "pathname" # **deprecated** # OvO is a comment plugin written by the author of Minima. # It is enabled when params.comment is set "ovo". You can -# find its documentation on https://github.com/ovojs/ovo. -# If you are using disqus or utterance, just ignore this field. +# have a live view on https://ovo.js.org. If you are using +# disqus or utterance, just ignore this. [params.ovo] server = "" placeholder = "" @@ -130,9 +130,8 @@ tag = "tags" series = "series" -# Fields below makes sure all the codes in a post are +# Fields below make sure all the codes in a post are # highlighted correctly, so better not edit them. [markup.highlight] lineNos = true noClasses = false - diff --git a/exampleSite/content/instruction.md b/exampleSite/content/instruction.md index fb5b7f5..2fe1eae 100644 --- a/exampleSite/content/instruction.md +++ b/exampleSite/content/instruction.md @@ -48,8 +48,8 @@ Follow [exampleSite/config.toml](https://github.com/Mivinci/hugo-theme-minima/bl ### Supported Front Matters | Field | Type | Explanation | -| ----------- | ------ | ------------------------------------------------------ | -| title | string | Title of the post, will be rendered in a `h1` tag | +|:----------- |:------ |:------------------------------------------------------ | +| title | string | Title of the post,
will be rendered in a `h1` tag | | description | string | Description of the post, will be rendered in a `p` tag | | date | string | Datetime that the post is written | | categories | array | Array of categories the posts belongs to | diff --git a/images/tn.png b/images/tn.png index d519227..1d11cba 100644 Binary files a/images/tn.png and b/images/tn.png differ