diff options
author | 7ma7X <hellorusk1998@gmail.com> | 2020-06-01 13:04:19 +0300 |
---|---|---|
committer | 7ma7X <hellorusk1998@gmail.com> | 2020-06-01 13:04:19 +0300 |
commit | a3f5387c24fb148ef037c40d6688a7cb4bb99082 (patch) | |
tree | 6eccce6cefc8c0674a64bcdd707a88ade919dd5f | |
parent | b025d673f41c24c88049bef69c7318110fdb185f (diff) |
write docs
-rw-r--r-- | README.md | 51 | ||||
-rw-r--r-- | exampleSite/config.toml | 2 | ||||
-rw-r--r-- | images/screenshot.png | bin | 0 -> 128519 bytes | |||
-rw-r--r-- | theme.toml | 5 |
4 files changed, 53 insertions, 5 deletions
@@ -1 +1,50 @@ -# WIP
\ No newline at end of file +# HugoTeX + +A hugo theme which looks like a LaTeX document. + +![screenshot](images/screenshot.png) + +**Live Demo: https://hugotex.netlify.app/** + +## Quick Start + +``` +git clone https://github.com/7ma7X/HugoTeX +cd HugoTeX/exampleSite +hugo server -t ../.. +``` + +Hugo (>= **0.60.1**) is required. + +This theme is heavily inspired by [latex-css](https://github.com.cnpmjs.org/vincentdoerig/latex-css). + +## config settings + +example + +```toml +baseURL = "https://hugotex.netlify.app/" +title = "HugoTeX" +paginate = 3 +languageCode = "en" +DefaultContentLanguage = "en" +enableInlineShortcodes = true +footnoteReturnLinkContents = "^" + +[author] + name = "Kaito Sugimoto" + abstract = "I'm a software engineer and a coffee enthusiast in Japan. My primary interest lies in the area of natural language processing." + +[taxonomies] +category = "categories" +tag = "tags" +series = "series" +``` + +## For contributors + +Any issues or pull requests are welcome. + +## LICENSE + +MIT
\ No newline at end of file diff --git a/exampleSite/config.toml b/exampleSite/config.toml index ffa1400..f5568f5 100644 --- a/exampleSite/config.toml +++ b/exampleSite/config.toml @@ -3,6 +3,8 @@ title = "HugoTeX" paginate = 3 languageCode = "en" DefaultContentLanguage = "en" +enableInlineShortcodes = true +footnoteReturnLinkContents = "^" [author] name = "Kaito Sugimoto" diff --git a/images/screenshot.png b/images/screenshot.png Binary files differnew file mode 100644 index 0000000..b50c9dc --- /dev/null +++ b/images/screenshot.png @@ -1,11 +1,8 @@ -# theme.toml template for a Hugo theme -# See https://github.com/gohugoio/hugoThemes#themetoml for an example - name = "HugoTeX" license = "MIT" licenselink = "https://github.com/7ma7X/HugoTeX" description = "LaTeX style hugo theme" -homepage = "http://example.com/" +homepage = "https://hugotex.netlify.app/" tags = ["blog", "minimal", "simple", "LaTeX"] features = ["minimal", "simple", "responsive", "syntax highlight", "LaTeX"] min_version = "0.60.1" |