From b2c5307a43835b1c6c037763ef248256c7def04e Mon Sep 17 00:00:00 2001 From: nanxiaobei Date: Fri, 7 Jul 2023 16:45:40 +0800 Subject: [PATCH] update docs --- README.md | 36 ++++++++++++++++++------------------ 1 file changed, 18 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 36fdc18..5533e7e 100755 --- a/README.md +++ b/README.md @@ -5,9 +5,9 @@ Demo → [hugo-paper.vercel.app](https://hugo-paper.vercel.app/)
-A simple, clean, flexible Hugo theme. +A simple, clean, customizable Hugo theme. -⚡️ Fast | 📸 Fluent | 🫙 Smooth +⚡️ Fast | 👒 Customizable (`linen` ░ `wheat` ░ `gray` ░ `light`) | 🫙 Smooth @@ -26,22 +26,6 @@ Hugo themes: [themes.gohugo.io/hugo-paper](https://themes.gohugo.io/hugo-paper/) ![](./images/screenshot_mobile.png) ![](./images/pagespeed.png) -## Install - -Inside the folder of your Hugo project, run: - -```bash -git submodule add https://github.com/nanxiaobei/hugo-paper themes/paper -``` - -Open `config.toml` or `hugo.toml`, change `theme` to `"paper"`: - -```toml -theme = "paper" -``` - -For more information, please read the [official guide](https://gohugo.io/getting-started/quick-start/#step-3-add-a-theme) of Hugo. - ## Options Available options to `config.toml` or `hugo.toml`: @@ -82,6 +66,22 @@ comments = false # disable comments for a specific pa math = true # enable KaTex math typesetting for a specific page ``` +## Install + +Inside the folder of your Hugo project, run: + +```bash +git submodule add https://github.com/nanxiaobei/hugo-paper themes/paper +``` + +Open `config.toml` or `hugo.toml`, change `theme` to `"paper"`: + +```toml +theme = "paper" +``` + +For more information, please read the [official guide](https://gohugo.io/getting-started/quick-start/#step-3-add-a-theme) of Hugo. + ## License [MIT License](https://github.com/nanxiaobei/hugo-paper/blob/main/LICENSE) (c) [nanxiaobei](https://lee.so/)