-
Notifications
You must be signed in to change notification settings - Fork 16
/
docs.toml
86 lines (72 loc) · 2.7 KB
/
docs.toml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
baseURL = "https://docs.projectdissolve.com/"
defaultContentLanguage = "en"
defaultContentLanguageInSubdir = false
title = "Dissolve"
theme = ["github.com/google/docsy", "github.com/google/docsy/dependencies"]
enableGitInfo = true
enableInlineShortcodes = true
relativeURLs = false
## Configuration for BlackFriday markdown parser: https://github.com/russross/blackfriday
[blackfriday]
plainIDAnchors = true
hrefTargetBlank = true
angledQuotes = false
latexDashes = true
[markup]
[markup.goldmark]
[markup.goldmark.renderer]
unsafe = true
## Menu Definition
[menu]
[[menu.main]]
name = "Home"
url = "https://projectdissolve.com/"
weight = 1
[[menu.main]]
name = "Packages"
url = "https://projectdissolve.com/packages/"
weight = 2
[[menu.main]]
name = "User Guide"
url = "https://docs.projectdissolve.com/"
weight = 3
[[menu.main]]
name = "Examples"
url = "https://docs.projectdissolve.com/examples/"
weight = 4
# General Parameters
[params]
copyright = "Team Dissolve and contributors. Built using Hugo/Docsy."
releaseVersion = "1.3.2"
releaseDate = "3rd August 2023"
github_repo = "https://github.com/disorderedmaterials/dissolve"
github_subdir = "web"
github_branch = "develop"
# Documentation Index Description
[params.docinfo]
release = "Here you can find the user guide and examples for the current release of Dissolve (vMAJOR.MINOR). Updated documentation for the current development version is [available here](/dev), and documentation for the previous release series can be [found here](/legacy)."
development = "Here you can find the user guide and examples for the current development version of Dissolve (vMAJOR.MINOR), describing any exciting and upcoming new features."
legacy = "Here you can find the user guide and examples for the previous major release series of Dissolve (vMAJOR.MINOR). This should be considered as legacy documentation and will be removed at some point."
# User interface configuration
[params.ui]
# Set to true to disable breadcrumb navigation.
breadcrumb_disable = true
# Enable to show the side bar menu in its compact state
sidebar_menu_compact = true
# Set to false if you don't want to display a logo (/assets/icons/logo.svg) in the top nav bar
navbar_logo = true
# Link Definitions
[params.links]
# End user relevant links. These will show up on left side of footer and in the community page if you have one.
[[params.links.developer]]
name = "GitHub"
url = "https://github.com/disorderedmaterials/dissolve"
icon = "fab fa-github"
desc = "Development takes place here!"
# Modules
[module]
proxy = "direct"
[[module.imports]]
path = "github.com/google/docsy"
[[module.imports]]
path = "github.com/google/docsy/dependencies"