chore(doc): add English "Theme Documentation - Basics"
This commit is contained in:
Dillon
@@ -27,7 +27,7 @@ html {
|
|||||||
}
|
}
|
||||||
|
|
||||||
body {
|
body {
|
||||||
font-weight: 400;
|
font-weight: 300;
|
||||||
line-height: 1.5rem;
|
line-height: 1.5rem;
|
||||||
background-color: $global-background-color;
|
background-color: $global-background-color;
|
||||||
color: $global-font-color;
|
color: $global-font-color;
|
||||||
@@ -58,6 +58,10 @@ body {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
b, strong {
|
||||||
|
font-weight: bold;
|
||||||
|
}
|
||||||
|
|
||||||
a {
|
a {
|
||||||
color: $global-link-color;
|
color: $global-link-color;
|
||||||
text-decoration: none;
|
text-decoration: none;
|
||||||
|
|||||||
@@ -2,14 +2,3 @@
|
|||||||
// Override Variables
|
// Override Variables
|
||||||
// 覆盖变量
|
// 覆盖变量
|
||||||
// ==============================
|
// ==============================
|
||||||
// You can override the variables in assets/css/_variables.scss to customize the style
|
|
||||||
// 您可以覆盖 assets/css/_variables.scss 中的变量
|
|
||||||
|
|
||||||
@import url(https://fonts.googleapis.com/css?family=Lato:100,300,400,700,900);
|
|
||||||
|
|
||||||
$global-font-family: Lato, -apple-system, BlinkMacSystemFont, PingFang SC, Microsoft Yahei, Segoe UI, Helvetica, Arial, sans-serif, Segoe UI Emoji;
|
|
||||||
|
|
||||||
|
|
||||||
@import url('https://fonts.googleapis.com/css?family=Fira+Mono:400,700&display=swap&subset=latin-ext');
|
|
||||||
|
|
||||||
$code-font-family: Fira Mono, Source Code Pro, Menlo, Consolas, Monaco, monospace;
|
|
||||||
|
|||||||
@@ -1,25 +0,0 @@
|
|||||||
---
|
|
||||||
title: "Documentation"
|
|
||||||
date: 2020-02-18T21:29:01+08:00
|
|
||||||
lastmod: 2020-02-18T21:29:01+08:00
|
|
||||||
draft: true
|
|
||||||
author: ""
|
|
||||||
authorLink: ""
|
|
||||||
description: ""
|
|
||||||
license: ""
|
|
||||||
|
|
||||||
tags: []
|
|
||||||
categories: []
|
|
||||||
hiddenFromHomePage: false
|
|
||||||
|
|
||||||
featuredImage: ""
|
|
||||||
featuredImagePreview: ""
|
|
||||||
|
|
||||||
toc: false
|
|
||||||
autoCollapseToc: true
|
|
||||||
lightgallery: true
|
|
||||||
math: false
|
|
||||||
comment: true
|
|
||||||
---
|
|
||||||
|
|
||||||
<!--more-->
|
|
||||||
539
exampleSite/content/posts/theme-documentation-basics.en.md
Normal file
539
exampleSite/content/posts/theme-documentation-basics.en.md
Normal file
@@ -0,0 +1,539 @@
|
|||||||
|
---
|
||||||
|
title: "Theme Documentation - Basics"
|
||||||
|
date: 2020-02-18T21:29:01+08:00
|
||||||
|
lastmod: 2020-02-18T21:29:01+08:00
|
||||||
|
draft: false
|
||||||
|
author: "Dillon"
|
||||||
|
authorLink: "https://dillonzq.com"
|
||||||
|
description: "Discover what the Hugo LoveIt theme is all about and the core-concepts behind it"
|
||||||
|
license: ""
|
||||||
|
|
||||||
|
tags: ["installation", "configuration"]
|
||||||
|
categories: ["documentation"]
|
||||||
|
hiddenFromHomePage: false
|
||||||
|
|
||||||
|
featuredImage: "/images/theme-documentation-basics.webp"
|
||||||
|
featuredImagePreview: ""
|
||||||
|
|
||||||
|
toc: true
|
||||||
|
autoCollapseToc: false
|
||||||
|
lightgallery: true
|
||||||
|
math: true
|
||||||
|
comment: true
|
||||||
|
---
|
||||||
|
|
||||||
|
Discover what the Hugo **LoveIt** theme is all about and the core-concepts behind it.
|
||||||
|
|
||||||
|
<!--more-->
|
||||||
|
|
||||||
|
## 1 Requirements
|
||||||
|
|
||||||
|
Thanks to the simplicity of Hugo, [Hugo](https://gohugo.io/) is the only dependency of this theme.
|
||||||
|
|
||||||
|
Just download latest version of [Hugo (> 0.62.0)](https://gohugo.io/getting-started/installing/) for your OS (Windows, Linux, Mac).
|
||||||
|
|
||||||
|
{{< admonition note "Why not support earlier versions of Hugo?" >}}
|
||||||
|
Since [Markdown Render Hooks](https://gohugo.io/getting-started/configuration-markup/#markdown-render-hooks) was introduced in the [Hugo Christmas Edition](https://gohugo.io/news/0.62.0-relnotes/), this theme only supports Hugo versions above v0.62.0.
|
||||||
|
{{< /admonition >}}
|
||||||
|
|
||||||
|
## 2 Installation
|
||||||
|
|
||||||
|
The following steps are here to help you initialize your new website. If you don’t know Hugo at all, we strongly suggest you learn more about it by following this [great documentation for beginners](https://gohugo.io/getting-started/quick-start/).
|
||||||
|
|
||||||
|
### 2.1 Create your project
|
||||||
|
|
||||||
|
Hugo provides a `new` command to create a new website:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
hugo new site my_website
|
||||||
|
cd my_website
|
||||||
|
```
|
||||||
|
|
||||||
|
### 2.2 Install the theme
|
||||||
|
|
||||||
|
The **LoveIt** theme’s repository is: [https://github.com/dillonzq/LoveIt](https://github.com/dillonzq/LoveIt).
|
||||||
|
|
||||||
|
Clone this repository to your hugo **themes** directory:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git clone -b master https://github.com/dillonzq/LoveIt.git themes/LoveIt
|
||||||
|
```
|
||||||
|
|
||||||
|
Or, create an empty git repository and make this repository a submodule of your site directory:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git init
|
||||||
|
git submodule -b master add https://github.com/dillonzq/LoveIt.git themes/LoveIt
|
||||||
|
```
|
||||||
|
|
||||||
|
Alternatively, you can download the latest release of the theme as .zip file and extract it in the **themes** directory.
|
||||||
|
|
||||||
|
### 2.3 Basic configuration
|
||||||
|
|
||||||
|
The following is a basic configuration for the LoveIt theme:
|
||||||
|
|
||||||
|
```toml
|
||||||
|
baseURL = "http://example.org/"
|
||||||
|
languageCode = "en"
|
||||||
|
title = "My New Hugo Site"
|
||||||
|
|
||||||
|
# Change the default theme to be use when building the site with Hugo
|
||||||
|
theme = "LoveIt"
|
||||||
|
|
||||||
|
[params]
|
||||||
|
# LoveIt theme version
|
||||||
|
version = "0.1.X"
|
||||||
|
```
|
||||||
|
|
||||||
|
{{< admonition note >}}
|
||||||
|
When building the website, you can set a theme by using `--theme` option. However, we suggest you modify the configuration file (**config.toml**) and set the theme as the default.
|
||||||
|
{{< /admonition >}}
|
||||||
|
|
||||||
|
### 2.4 Create your first post
|
||||||
|
|
||||||
|
Here is the way to create your first post:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
hugo new posts/first_post.md
|
||||||
|
```
|
||||||
|
|
||||||
|
Feel free to edit the post file by adding some sample content and replacing the title value in the beginning of the file.
|
||||||
|
|
||||||
|
{{< admonition note >}}
|
||||||
|
By default all posts and pages are created as a draft. If you want to render these pages, remove the property `draft: true` from the metadata or set the property `draft: false`.
|
||||||
|
{{< /admonition >}}
|
||||||
|
|
||||||
|
### 2.5 Launching the website locally
|
||||||
|
|
||||||
|
Launch by using the following command:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
hugo serve
|
||||||
|
```
|
||||||
|
|
||||||
|
Go to `http://localhost:1313`.
|
||||||
|
|
||||||
|
{{< admonition tip >}}
|
||||||
|
When you run `hugo serve`, when the contents of the files change, the page automatically refreshes with the changes.
|
||||||
|
{{< /admonition >}}
|
||||||
|
|
||||||
|
### 2.6 Build the website
|
||||||
|
|
||||||
|
When your site is ready to deploy, run the following command:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
hugo
|
||||||
|
```
|
||||||
|
|
||||||
|
A `public` folder will be generated, containing all static content and assets for your website. It can now be deployed on any web server.
|
||||||
|
|
||||||
|
{{< admonition tip >}}
|
||||||
|
The website can be automatically published and hosted with [Netlify](https://www.netlify.com/) (Read more about [Automated HUGO deployments with Netlify](https://www.netlify.com/blog/2015/07/30/hosting-hugo-on-netlifyinsanely-fast-deploys/)).
|
||||||
|
Alternatively, you can use [Github pages](https://gohugo.io/hosting-and-deployment/hosting-on-github/).
|
||||||
|
{{< /admonition >}}
|
||||||
|
|
||||||
|
## 3 Configuration
|
||||||
|
|
||||||
|
### 3.1 `config.toml`
|
||||||
|
|
||||||
|
On top of [Hugo global configuration](https://gohugo.io/overview/configuration/), **LoveIt** lets you define the following parameters in your `config.toml` (here, values are default).
|
||||||
|
|
||||||
|
{{< admonition >}}
|
||||||
|
Note that some of these parameters are explained in details in other sections of this documentation.
|
||||||
|
{{< /admonition >}}
|
||||||
|
|
||||||
|
```toml
|
||||||
|
[menu]
|
||||||
|
[[menu.main]]
|
||||||
|
identifier = "posts"
|
||||||
|
name = "Posts"
|
||||||
|
url = "/posts/"
|
||||||
|
weight = 1
|
||||||
|
[[menu.main]]
|
||||||
|
identifier = "tags"
|
||||||
|
name = "Tags"
|
||||||
|
url = "/tags/"
|
||||||
|
weight = 2
|
||||||
|
[[menu.main]]
|
||||||
|
identifier = "categories"
|
||||||
|
name = "Categories"
|
||||||
|
url = "/categories/"
|
||||||
|
weight = 3
|
||||||
|
[[menu.main]]
|
||||||
|
identifier = "about"
|
||||||
|
name = "About"
|
||||||
|
url = "/about/"
|
||||||
|
weight = 4
|
||||||
|
|
||||||
|
[params]
|
||||||
|
# LoveIt theme version
|
||||||
|
version = "0.1.X"
|
||||||
|
# site description
|
||||||
|
description = "About LoveIt Theme"
|
||||||
|
# site keywords
|
||||||
|
keywords = ["Theme", "Hugo"]
|
||||||
|
# site default theme ("light", "dark", "auto")
|
||||||
|
defaultTheme = "auto"
|
||||||
|
# public git repo url to link lastmod git commit only then enableGitInfo is true
|
||||||
|
gitRepo = ""
|
||||||
|
# Header info
|
||||||
|
[params.header]
|
||||||
|
# desktop header mode ("fixed", "normal", "auto")
|
||||||
|
desktopMode = "fixed"
|
||||||
|
# mobile header mode ("fixed", "normal", "auto")
|
||||||
|
mobileMode = "auto"
|
||||||
|
# Footer Copyright Info
|
||||||
|
[params.footer]
|
||||||
|
# Site creation time
|
||||||
|
since = 2019
|
||||||
|
# ICP info only in China (HTML format is allowed)
|
||||||
|
icp = ""
|
||||||
|
# license info (HTML format is allowed)
|
||||||
|
license= '<a rel="license external nofollow noopener noreffer" href="https://creativecommons.org/licenses/by-nc/4.0/" target="_blank">CC BY-NC 4.0</a>'
|
||||||
|
# Home Page Info
|
||||||
|
[params.home]
|
||||||
|
# Home Page Profile
|
||||||
|
[params.home.profile]
|
||||||
|
enable = true
|
||||||
|
# Gravatar Email for preferred avatar in home page
|
||||||
|
gravatarEmail = ""
|
||||||
|
# URL of avatar shown in home page
|
||||||
|
avatarURL = "/images/avatar.png"
|
||||||
|
# subtitle shown in home page
|
||||||
|
subtitle = "A Clean, Elegant but Advanced Hugo Theme"
|
||||||
|
# whether to use typeit animation for subtitle
|
||||||
|
typeit = true
|
||||||
|
# whether to show social links
|
||||||
|
social = true
|
||||||
|
# Home Page Posts
|
||||||
|
[params.home.posts]
|
||||||
|
enable = true
|
||||||
|
# special amount of posts in each home posts page
|
||||||
|
paginate = 6
|
||||||
|
# default behavior when you don't set "hiddenFromHomePage" in front matter
|
||||||
|
defaultHiddenFromHomePage = false
|
||||||
|
# Social Info in home page
|
||||||
|
[params.social]
|
||||||
|
GitHub = "xxxx"
|
||||||
|
Linkedin = "xxxx"
|
||||||
|
Twitter = "xxxx"
|
||||||
|
Instagram = "xxxx"
|
||||||
|
Email = "xxxx@xxxx.com"
|
||||||
|
Facebook = "xxxx"
|
||||||
|
Telegram = "xxxx"
|
||||||
|
# Medium = "xxxx"
|
||||||
|
# Gitlab = "xxxx"
|
||||||
|
Youtubelegacy = "xxxx"
|
||||||
|
# Youtubecustom = "xxxx"
|
||||||
|
# Youtubechannel = "xxxx"
|
||||||
|
# Tumblr ="xxxx"
|
||||||
|
# Quora = "xxxx"
|
||||||
|
# Keybase = "xxxx"
|
||||||
|
# Pinterest = "xxxx"
|
||||||
|
# Reddit = "xxxx"
|
||||||
|
# Codepen = "xxxx"
|
||||||
|
# FreeCodeCamp = "xxxx"
|
||||||
|
# Bitbucket = "xxxx"
|
||||||
|
# Stackoverflow = "xxxx"
|
||||||
|
# Weibo = "xxxx"
|
||||||
|
# Odnoklassniki = "xxxx"
|
||||||
|
# VK = "xxxx"
|
||||||
|
# Flickr = "xxxx"
|
||||||
|
# Xing = "xxxx"
|
||||||
|
# Snapchat = "xxxx"
|
||||||
|
# Soundcloud = "xxxx"
|
||||||
|
# Spotify = "xxxx"
|
||||||
|
# Bandcamp = "xxxx"
|
||||||
|
# Paypal = "xxxx"
|
||||||
|
# Fivehundredpx = "xxxx"
|
||||||
|
# Mix = "xxxx"
|
||||||
|
# Goodreads = "xxxx"
|
||||||
|
# Lastfm = "xxxx"
|
||||||
|
# Foursquare = "xxxx"
|
||||||
|
# Hackernews = "xxxx"
|
||||||
|
# Kickstarter = "xxxx"
|
||||||
|
# Patreon = "xxxx"
|
||||||
|
# Steam = "xxxx"
|
||||||
|
# Twitch = "xxxx"
|
||||||
|
# Strava = "xxxx"
|
||||||
|
# Skype = "xxxx"
|
||||||
|
# Whatsapp = "xxxx"
|
||||||
|
# Zhihu = "xxxx"
|
||||||
|
# Douban = "xxxx"
|
||||||
|
# Angellist = "xxxx"
|
||||||
|
# Slidershare = "xxxx"
|
||||||
|
# Jsfiddle = "xxxx"
|
||||||
|
# Deviantart = "xxxx"
|
||||||
|
# Behance = "xxxx"
|
||||||
|
# Dribble = "xxxx"
|
||||||
|
# Wordpress = "xxxx"
|
||||||
|
# Vine = "xxxx"
|
||||||
|
# Googlescholar = "xxxx"
|
||||||
|
# Researchgate = "xxxx"
|
||||||
|
# Mastodon = "xxxx"
|
||||||
|
# MastodonPrefix = "https://mastodon.technology/"
|
||||||
|
# Thingiverse = "xxxx"
|
||||||
|
# Devto = "xxxx"
|
||||||
|
# Gitea = "xxxx"
|
||||||
|
# XMPP = "xxxx"
|
||||||
|
# Matrix = "xxxx"
|
||||||
|
# Bilibili = "xxxx"
|
||||||
|
|
||||||
|
# Page config
|
||||||
|
[params.page]
|
||||||
|
# whether to use lightgallery in the page
|
||||||
|
lightgallery = true
|
||||||
|
# whether to show link to Raw Markdown content of the post
|
||||||
|
linkToMarkdown = true
|
||||||
|
# mathematical formulas (KaTeX)
|
||||||
|
[params.math]
|
||||||
|
enable = true
|
||||||
|
# default block delimiter is $$ ... $$ and \\[ ... \\]
|
||||||
|
blockLeftDelimiter = ""
|
||||||
|
blockRightDelimiter = ""
|
||||||
|
# default inline delimiter is $ ... $ and \\( ... \\)
|
||||||
|
inlineLeftDelimiter = ""
|
||||||
|
inlineRightDelimiter = ""
|
||||||
|
# KaTeX extension copy_tex
|
||||||
|
copyTex = true
|
||||||
|
# KaTeX extension mhchem
|
||||||
|
mhchem = true
|
||||||
|
# Social Share Links in post page
|
||||||
|
[params.share]
|
||||||
|
enable = true
|
||||||
|
Twitter = true
|
||||||
|
Facebook = true
|
||||||
|
Linkedin = true
|
||||||
|
Whatsapp = true
|
||||||
|
Pinterest = true
|
||||||
|
# Tumblr = true
|
||||||
|
HackerNews = true
|
||||||
|
# Reddit = true
|
||||||
|
# VK = true
|
||||||
|
# Buffer = true
|
||||||
|
# Xing = true
|
||||||
|
# Line = true
|
||||||
|
# Instapaper = true
|
||||||
|
# Pocket = true
|
||||||
|
# Digg = true
|
||||||
|
# Stumbleupon = true
|
||||||
|
# Flipboard = true
|
||||||
|
# Weibo = true
|
||||||
|
# Renren = true
|
||||||
|
# Myspace = true
|
||||||
|
# Blogger = true
|
||||||
|
# Baidu = true
|
||||||
|
# Odnoklassniki = true
|
||||||
|
# Evernote = true
|
||||||
|
# Skype = true
|
||||||
|
# Trello = true
|
||||||
|
# Mix = true
|
||||||
|
# Comment Config
|
||||||
|
[params.comment]
|
||||||
|
enable = true
|
||||||
|
# Disqus Comment Config (https://disqus.com/)
|
||||||
|
[params.comment.disqus]
|
||||||
|
# Disqus shortname to use Disqus in posts
|
||||||
|
shortname = "dillonzq"
|
||||||
|
# Gittalk Comment Config (https://github.com/gitalk/gitalk)
|
||||||
|
[params.comment.gitalk]
|
||||||
|
owner = ""
|
||||||
|
repo = ""
|
||||||
|
clientId = ""
|
||||||
|
clientSecret = ""
|
||||||
|
# Valine Comment Config (https://github.com/xCss/Valine)
|
||||||
|
[params.comment.valine]
|
||||||
|
enable = false
|
||||||
|
appId = ""
|
||||||
|
appKey = ""
|
||||||
|
placeholder = "Your comment ..."
|
||||||
|
notify = false
|
||||||
|
verify = true
|
||||||
|
avatar = "mp"
|
||||||
|
# meta= ""
|
||||||
|
pageSize = 10
|
||||||
|
visitor = true
|
||||||
|
recordIP = true
|
||||||
|
# Facebook Comment Config (https://developers.facebook.com/docs/plugins/comments)
|
||||||
|
[params.comment.facebook]
|
||||||
|
enable = false
|
||||||
|
width = "100%"
|
||||||
|
numPosts = 10
|
||||||
|
appId = ""
|
||||||
|
languageCode = "en_US"
|
||||||
|
|
||||||
|
# site verification code for Google/Bing/Yandex/Pinterest/Baidu
|
||||||
|
[params.verification]
|
||||||
|
google = ""
|
||||||
|
bing = ""
|
||||||
|
yandex = ""
|
||||||
|
pinterest = ""
|
||||||
|
baidu = ""
|
||||||
|
# Publisher Info just for SEO
|
||||||
|
[params.publisher]
|
||||||
|
name = "xxxx"
|
||||||
|
[params.publisher.logo]
|
||||||
|
url = "logo.png"
|
||||||
|
width = 127
|
||||||
|
height = 40
|
||||||
|
# Website Log Info just for SEO
|
||||||
|
[params.logo]
|
||||||
|
url = "logo.png"
|
||||||
|
width = 127
|
||||||
|
height = 40
|
||||||
|
# Website Image Info just for SEO
|
||||||
|
[params.image]
|
||||||
|
url = "cover.png"
|
||||||
|
width = 800
|
||||||
|
height = 600
|
||||||
|
# CSS and JS Files CDN
|
||||||
|
[params.cdn]
|
||||||
|
# fontawesome-free@5.12.1 https://fontawesome.com/
|
||||||
|
fontawesomeFreeCSS = ''
|
||||||
|
# animate.css@3.7.2 https://github.com/daneden/animate.css
|
||||||
|
animateCSS = ''
|
||||||
|
# smooth-scroll@16.1.2 https://github.com/cferdinandi/smooth-scroll
|
||||||
|
smoothScrollJS = ''
|
||||||
|
# sharer@0.4.0 https://github.com/ellisonleao/sharer.js
|
||||||
|
sharerJS = ''
|
||||||
|
# lazysizes@5.2.0 https://github.com/aFarkas/lazysizes
|
||||||
|
lazysizesJS = ''
|
||||||
|
# lightgallery@1.1.3 lg-thumbnail@1.1.0 lg-zoom@1.1.0 https://github.com/sachinchoolur/lightgallery.js
|
||||||
|
lightgalleryCSS = ''
|
||||||
|
lightgalleryJS = ''
|
||||||
|
lightgalleryThumbnailJS = ''
|
||||||
|
lightgalleryZoomJS = ''
|
||||||
|
# typeit@6.5.1 https://github.com/alexmacarthur/typeit
|
||||||
|
typeitJS = ''
|
||||||
|
# katex@0.11.1 https://github.com/KaTeX/KaTeX
|
||||||
|
katexCSS = ''
|
||||||
|
katexJS = ''
|
||||||
|
katexAutoRenderJS = ''
|
||||||
|
katexCopyTexCSS = ''
|
||||||
|
katexCopyTexJS = ''
|
||||||
|
katexMhchemJS = ''
|
||||||
|
# mermaid@8.4.8 https://github.com/knsv/mermaid
|
||||||
|
mermaidJS = ''
|
||||||
|
# aplayer@1.10.1 https://github.com/MoePlayer/APlayer
|
||||||
|
aplayerCSS = ''
|
||||||
|
aplayerJS = ''
|
||||||
|
# meting@2.0.1 https://github.com/metowolf/MetingJS
|
||||||
|
metingJS = ''
|
||||||
|
# echarts@4.6.0 https://echarts.apache.org/
|
||||||
|
echartsJS = ''
|
||||||
|
echartsMacaronsJS = ''
|
||||||
|
# gitalk@1.6.0 https://github.com/gitalk/gitalk
|
||||||
|
gitalkCSS = ''
|
||||||
|
gitalkJS = ''
|
||||||
|
# valine@1.3.10 https://valine.js.org/
|
||||||
|
valineJS = ''
|
||||||
|
|
||||||
|
# Markup related configuration in Hugo
|
||||||
|
[markup]
|
||||||
|
# Syntax Highlighting (https://gohugo.io/content-management/syntax-highlighting)
|
||||||
|
[markup.highlight]
|
||||||
|
codeFences = true
|
||||||
|
guessSyntax = true
|
||||||
|
lineNoStart = 1
|
||||||
|
lineNos = true
|
||||||
|
lineNumbersInTable = true
|
||||||
|
noClasses = false
|
||||||
|
style = "monokai"
|
||||||
|
tabWidth = 4
|
||||||
|
# Goldmark is from Hugo 0.60 the default library used for Markdown
|
||||||
|
[markup.goldmark]
|
||||||
|
[markup.goldmark.extensions]
|
||||||
|
definitionList = true
|
||||||
|
footnote = true
|
||||||
|
linkify = true
|
||||||
|
strikethrough = true
|
||||||
|
table = true
|
||||||
|
taskList = true
|
||||||
|
typographer = true
|
||||||
|
[markup.goldmark.renderer]
|
||||||
|
# whether to use HTML tags directly in the document
|
||||||
|
unsafe = true
|
||||||
|
# Table Of Contents settings
|
||||||
|
[markup.tableOfContents]
|
||||||
|
startLevel = 2
|
||||||
|
endLevel = 6
|
||||||
|
|
||||||
|
# Author Info
|
||||||
|
[author]
|
||||||
|
name = "xxxx"
|
||||||
|
link = ""
|
||||||
|
|
||||||
|
# Sitemap Info
|
||||||
|
[sitemap]
|
||||||
|
changefreq = "weekly"
|
||||||
|
filename = "sitemap.xml"
|
||||||
|
priority = 0.5
|
||||||
|
|
||||||
|
# Permalinks Info (https://gohugo.io/content-management/urls/#permalinks)
|
||||||
|
[Permalinks]
|
||||||
|
# posts = ":year/:month/:filename"
|
||||||
|
posts = ":filename"
|
||||||
|
|
||||||
|
# Privacy Info (https://gohugo.io/about/hugo-and-gdpr/)
|
||||||
|
[privacy]
|
||||||
|
[privacy.googleAnalytics]
|
||||||
|
anonymizeIP = true
|
||||||
|
|
||||||
|
[privacy.youtube]
|
||||||
|
privacyEnhanced = true
|
||||||
|
|
||||||
|
# Options to make output .md files
|
||||||
|
[mediaTypes]
|
||||||
|
[mediaTypes."text/plain"]
|
||||||
|
suffixes = ["md"]
|
||||||
|
|
||||||
|
# Options to make output .md files
|
||||||
|
[outputFormats.MarkDown]
|
||||||
|
mediaType = "text/plain"
|
||||||
|
isPlainText = true
|
||||||
|
isHTML = false
|
||||||
|
|
||||||
|
# Options to make hugo output files
|
||||||
|
[outputs]
|
||||||
|
home = ["HTML", "RSS"]
|
||||||
|
page = ["HTML", "MarkDown"]
|
||||||
|
section = ["HTML", "RSS"]
|
||||||
|
taxonomy = ["HTML", "RSS"]
|
||||||
|
taxonomyTerm = ["HTML"]
|
||||||
|
```
|
||||||
|
|
||||||
|
### 3.2 Favicons, Browserconfig, Manifest
|
||||||
|
|
||||||
|
It is recommended to put your own favicons
|
||||||
|
|
||||||
|
* apple-touch-icon.png (180x180)
|
||||||
|
* favicon-32x32.png (32x32)
|
||||||
|
* favicon-16x16.png (16x16)
|
||||||
|
* mstile-150x150.png (150x150)
|
||||||
|
* android-chrome-192x192.png (192x192)
|
||||||
|
* android-chrome-512x512.png (512x512)
|
||||||
|
|
||||||
|
into `/static`. They’re easily created via [https://realfavicongenerator.net/](https://realfavicongenerator.net/).
|
||||||
|
|
||||||
|
Customize `browserconfig.xml` and `site.webmanifest` to set theme-color and background-color.
|
||||||
|
|
||||||
|
### 3.3 Add logo and cover for SEO
|
||||||
|
|
||||||
|
Add a logo image (127x40) and a cover image (800x600) in the `static` directory.
|
||||||
|
|
||||||
|
### 3.4 Style Customization
|
||||||
|
|
||||||
|
**LoveIt** has been built to be as configurable as possible by defining custom `.scss` style files.
|
||||||
|
|
||||||
|
The directory including the custom `.scss` style files is `config/css` relative to **your project path**.
|
||||||
|
|
||||||
|
In `_override.scss`, you can override the variables in `assets/css/_variables.scss` relative to **LoveIt directory** to customize the style.
|
||||||
|
|
||||||
|
Here is a example:
|
||||||
|
|
||||||
|
```scss
|
||||||
|
@import url('https://fonts.googleapis.com/css?family=Fira+Mono:400,700&display=swap&subset=latin-ext');
|
||||||
|
$code-font-family: Fira Mono, Source Code Pro, Menlo, Consolas, Monaco, monospace;
|
||||||
|
```
|
||||||
|
|
||||||
|
In `_custom.scss`, you can add some css style code to customize the style.
|
||||||
BIN
exampleSite/static/images/theme-documentation-basics.webp
Normal file
BIN
exampleSite/static/images/theme-documentation-basics.webp
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 822 KiB |
File diff suppressed because one or more lines are too long
@@ -1 +1 @@
|
|||||||
{"Target":"css/style.min.22797a679118d2eb3f376ecb55adbba6052c813ae165d44e004bbf861d5a1ed1.css","MediaType":"text/css","Data":{"Integrity":"sha256-Inl6Z5EY0us/N27LVa27pgUsgTrhZdROAEu/hh1aHtE="}}
|
{"Target":"css/style.min.3d5f7d9e0effc9d059f777db86db5fe1452d3a8c222ab37a69553cba9313c1f3.css","MediaType":"text/css","Data":{"Integrity":"sha256-PV99ng7/ydBZ93fbhttf4UUtOowiKrN6aVU8upMTwfM="}}
|
||||||
Reference in New Issue
Block a user