add docs config.toml
This commit is contained in:
parent
afbcc95cce
commit
f66dd2cb4d
3 changed files with 62 additions and 0 deletions
27
docs/config.toml
Normal file
27
docs/config.toml
Normal file
|
@ -0,0 +1,27 @@
|
|||
# The URL the site will be built for
|
||||
base_url = "https://norgbackup.net"
|
||||
title = "Norg"
|
||||
description = "A portable wrapper for the borg and restic backup utilities"
|
||||
theme = "norgbackup"
|
||||
compile_sass = true
|
||||
build_search_index = true
|
||||
preserve_dotfiles_in_output = true
|
||||
|
||||
[markdown]
|
||||
highlight_code = true
|
||||
highlight_theme = "base16-ocean-light"
|
||||
|
||||
[extra]
|
||||
logo = "/norg-logo.png"
|
||||
favicon = "/favicon.png"
|
||||
easydocs_logo_always_clickable = false
|
||||
# For use with offline sites. If set to true links in the nav are generated with the full path indcluding index.html
|
||||
# Insired by Abridge theme https://www.getzola.org/themes/abridge/
|
||||
# Notes:
|
||||
# - Also requries the base URL to be set to the local folder where the site will be stored eg. base_url = file:///home/user/mysite/public/
|
||||
# - This is not portable and only works with a specific local folder
|
||||
easydocs_uglyurls = false
|
||||
|
||||
# Minimum number of headings needed on a page before the headings show in the navigation on the left. Defaults to 5.
|
||||
# Can be used for example to always show headings on each page by setting it to 1.
|
||||
easydocs_heading_threshold = 2
|
25
docs/themes/norgbackup/config.toml
vendored
Normal file
25
docs/themes/norgbackup/config.toml
vendored
Normal file
|
@ -0,0 +1,25 @@
|
|||
base_url = "https://easydocs.codeandmedia.com"
|
||||
title = "Docs"
|
||||
compile_sass = true
|
||||
build_search_index = true
|
||||
|
||||
[markdown]
|
||||
highlight_code = true
|
||||
highlight_theme = "base16-ocean-light"
|
||||
|
||||
[extra]
|
||||
logo = "https://easydocs.codeandmedia.com/logo.svg"
|
||||
release = "https://api.github.com/repos/getzola/zola/releases/latest"
|
||||
favicon = "https://www.getzola.org/favicon.ico"
|
||||
easydocs_logo_always_clickable = false
|
||||
|
||||
# For use with offline sites. If set to true links in the nav are generated with the full path indcluding index.html
|
||||
# Insired by Abridge theme https://www.getzola.org/themes/abridge/
|
||||
# Notes:
|
||||
# - Also requries the base URL to be set to the local folder where the site will be stored eg. base_url = file:///home/user/mysite/public/
|
||||
# - This is not portable and only works with a specific local folder
|
||||
easydocs_uglyurls = false
|
||||
|
||||
# Minimum number of headings needed on a page before the headings show in the navigation on the left. Defaults to 5.
|
||||
# Can be used for example to always show headings on each page by setting it to 1.
|
||||
easydocs_heading_threshold = 5
|
10
docs/themes/norgbackup/theme.toml
vendored
Normal file
10
docs/themes/norgbackup/theme.toml
vendored
Normal file
|
@ -0,0 +1,10 @@
|
|||
name = "EasyDocs"
|
||||
description = "An easy way to create docs for your project"
|
||||
license = "MIT"
|
||||
homepage = "https://github.com/codeandmedia/zola_easydocs_theme"
|
||||
min_version = "0.13.0"
|
||||
demo = "https://easydocs.codeandmedia.com"
|
||||
|
||||
[author]
|
||||
name = "Roman Soldatenkov"
|
||||
homepage = "https://codeandmedia.com"
|
Loading…
Reference in a new issue