From 01742beef1e52cab5e491ad2447a61d8b32a9908 Mon Sep 17 00:00:00 2001 From: nanxiaobei Date: Fri, 20 Aug 2021 19:39:36 +0800 Subject: [PATCH] update docs --- README.md | 31 +++++++++++++++++++++++-------- 1 file changed, 23 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 413287c..c2393f2 100755 --- a/README.md +++ b/README.md @@ -1,15 +1,20 @@ -# Paper v4.9 (Dark Mode) +
+

Paper 5.0

+ +Demo → [nanxiaobei.github.io/hugo-paper](https://nanxiaobei.github.io/hugo-paper) + +
A simple, clean, flexible Hugo theme. -☄️ Fast | ☁️ Fluent | 🌙 Smooth +⚡️ Fast | 🦋 Fluent | 🪀 Smooth + +
--- ## Overview -Demo: https://nanxiaobei.github.io/hugo-paper/ -

Paper @@ -22,8 +27,6 @@ Demo: https://nanxiaobei.github.io/hugo-paper/

-Hugo themes: https://themes.gohugo.io/hugo-paper/ - ## Install Inside the folder of your Hugo site, run: @@ -40,9 +43,21 @@ theme = "paper" For more information read the official [guide](https://gohugo.io/getting-started/quick-start/#step-3-add-a-theme) of Hugo. -## Dark Mode +Check on Hugo themes: https://themes.gohugo.io/hugo-paper/ -It's automatic, according to your system settings, or the natural time of day and night. +## Config + +Available configurations to `config.toml`: + +```toml +disqusShortname = 'YOUR_DISQUES_SHORTNAME' + +[params] + disableHLJS = true # don't load highlight.js + twitter = 'YOUR_TWITTER_ID' + github = 'YOUR_GITHUB_ID' + instagram = 'YOUR_INSTAGRAM_ID' +``` ## Pitiless Ads