2020-06-09 08:19:59 -04:00
|
|
|
# Project information
|
2022-02-28 00:30:49 -05:00
|
|
|
site_name: "Sailfish Documentation"
|
2020-06-09 08:19:59 -04:00
|
|
|
# site_description: 'Sailfish Documentation'
|
2022-02-28 00:30:49 -05:00
|
|
|
site_author: "Ryohei Machida"
|
2020-06-09 08:19:59 -04:00
|
|
|
# site_url: 'https://***.com'
|
|
|
|
|
|
|
|
# Copyright
|
2022-02-28 00:30:49 -05:00
|
|
|
copyright: "© 2020 Ryohei Machida"
|
2020-06-09 08:19:59 -04:00
|
|
|
|
|
|
|
# Repository
|
2022-02-28 00:30:49 -05:00
|
|
|
repo_name: "rust-sailfish/sailfish"
|
|
|
|
repo_url: "https://github.com/rust-sailfish/sailfish"
|
2020-06-09 08:19:59 -04:00
|
|
|
|
|
|
|
theme:
|
2022-02-28 00:30:49 -05:00
|
|
|
name: "material"
|
|
|
|
language: "en"
|
|
|
|
logo: "images/logo.svg"
|
2020-06-09 08:19:59 -04:00
|
|
|
palette:
|
2022-02-28 00:44:08 -05:00
|
|
|
- media: "(prefers-color-scheme: dark)"
|
|
|
|
scheme: "dark"
|
|
|
|
primary: "deep purple"
|
|
|
|
accent: "deep purple"
|
|
|
|
toggle:
|
|
|
|
icon: "material/lightbulb-outline"
|
|
|
|
name: "Light Mode"
|
|
|
|
- media: "(prefers-color-scheme: light)"
|
|
|
|
scheme: "default"
|
|
|
|
primary: "deep purple"
|
|
|
|
accent: "deep purple"
|
|
|
|
toggle:
|
|
|
|
icon: "material/lightbulb"
|
|
|
|
name: "Dark Mode"
|
2022-02-28 00:30:49 -05:00
|
|
|
favicon: "images/favicon.ico"
|
2020-06-09 08:19:59 -04:00
|
|
|
font:
|
2022-02-28 00:30:49 -05:00
|
|
|
text: "Ubuntu"
|
|
|
|
code: "Ubuntu Mono"
|
2021-01-03 04:00:29 -05:00
|
|
|
features:
|
2022-02-28 00:30:49 -05:00
|
|
|
- "navigation.expand"
|
2020-06-09 08:19:59 -04:00
|
|
|
|
|
|
|
# Extensions
|
|
|
|
markdown_extensions:
|
2022-02-28 00:30:49 -05:00
|
|
|
- "admonition"
|
|
|
|
- "footnotes"
|
|
|
|
- "pymdownx.highlight"
|
|
|
|
- "pymdownx.tabbed":
|
|
|
|
alternate_style: true
|
|
|
|
- "pymdownx.superfences":
|
2021-01-03 04:00:29 -05:00
|
|
|
custom_fences:
|
|
|
|
- name: mermaid
|
|
|
|
class: mermaid
|
2020-06-09 08:19:59 -04:00
|
|
|
|
2021-01-01 06:19:01 -05:00
|
|
|
extra_css:
|
2022-02-28 00:30:49 -05:00
|
|
|
- "assets/css/custom.css"
|
2020-06-09 08:19:59 -04:00
|
|
|
|
|
|
|
extra:
|
|
|
|
social:
|
2022-02-28 00:30:49 -05:00
|
|
|
- icon: "fontawesome/brands/github-alt"
|
|
|
|
link: "https://github.com/rust-sailfish"
|
2020-06-09 08:19:59 -04:00
|
|
|
|
|
|
|
# Page tree
|
|
|
|
nav:
|
2022-02-28 00:30:49 -05:00
|
|
|
- "Welcome": "index.md"
|
|
|
|
- "Installation": "installation.md"
|
|
|
|
- "Getting Started": "getting-started.md"
|
|
|
|
- "Configuration": "options.md"
|
|
|
|
- "Syntax":
|
|
|
|
- "Overview": "syntax/overview.md"
|
|
|
|
- "Tags": "syntax/tags.md"
|
|
|
|
- "Includes": "syntax/includes.md"
|
|
|
|
- "Filters": "syntax/filters.md"
|