feat(mkdocs): added default mkdocs.yml
This file is intended to be the default options required for building a section/website. the only sections a child mkdocs.yml will require are the navigation and repository details. MR !1 close #1 nofusscomputing/ops!5
This commit is contained in:
116
mkdocs.yml
Normal file
116
mkdocs.yml
Normal file
@ -0,0 +1,116 @@
|
||||
site_name: No Fuss Computing
|
||||
site_description: "Here at No Fuss Computing we predominately do research and development into, making your computing experience a more enjoyable one."
|
||||
site_url: https://nofusscomputing.com
|
||||
|
||||
site_author: No Fuss Computing
|
||||
copyright: Copyright © No Fuss Computing 2021
|
||||
|
||||
#site_favicon: favicon.ico
|
||||
|
||||
docs_dir: 'pages'
|
||||
site_dir: build
|
||||
|
||||
|
||||
theme:
|
||||
name: material
|
||||
logo: assets/logo.png
|
||||
custom_dir: website-template/theme-overrides
|
||||
icon:
|
||||
repo: fontawesome/brands/gitlab # (1)!
|
||||
locale: en
|
||||
font: false
|
||||
features:
|
||||
- navigation.tracking
|
||||
- navigation.tabs
|
||||
- navigation.tabs.sticky
|
||||
- navigation.expand
|
||||
- navigation.indexes
|
||||
- toc.integrate
|
||||
- navigation.top
|
||||
- header.autohide
|
||||
- navigation.sections
|
||||
- content.code.annotate
|
||||
|
||||
palette:
|
||||
- scheme: default
|
||||
primary: indigo
|
||||
accent: indigo
|
||||
toggle:
|
||||
icon: material/lightbulb-outline
|
||||
name: Switch to dark mode
|
||||
- scheme: slate
|
||||
primary: indigo
|
||||
accent: indigo
|
||||
toggle:
|
||||
icon: material/lightbulb
|
||||
name: Switch to light mode
|
||||
|
||||
extra_css:
|
||||
- stylesheets/extra.css
|
||||
|
||||
|
||||
plugins:
|
||||
- tags:
|
||||
filename: tags.md
|
||||
folder: pages
|
||||
css_name: ".tags"
|
||||
- search:
|
||||
lang: en
|
||||
|
||||
- git-revision-date-localized:
|
||||
type: iso_date
|
||||
enable_creation_date: true
|
||||
exclude:
|
||||
- index.md
|
||||
- tags.md
|
||||
# - minify:
|
||||
# minify_html: true
|
||||
|
||||
|
||||
|
||||
extra:
|
||||
homepage: https://nofusscomputing.com
|
||||
version: 1.0
|
||||
social:
|
||||
- link: https://hub.docker.com/u/nofusscomputing
|
||||
name: DockerHub
|
||||
icon: fontawesome/brands/docker
|
||||
|
||||
- link: https://facebook.com/NoFussComputing
|
||||
name: Facebook
|
||||
icon: fontawesome/brands/facebook
|
||||
|
||||
- link: https://gitlab.com/nofusscomputing
|
||||
name: Gitlab
|
||||
icon: fontawesome/brands/gitlab
|
||||
|
||||
- link: https://github.com/NoFussComputing
|
||||
name: Github
|
||||
icon: fontawesome/brands/github
|
||||
|
||||
|
||||
markdown_extensions:
|
||||
- def_list
|
||||
- pymdownx.tasklist:
|
||||
custom_checkbox: true
|
||||
- meta
|
||||
- attr_list
|
||||
- admonition
|
||||
- pymdownx.details
|
||||
- pymdownx.highlight:
|
||||
anchor_linenums: true
|
||||
- pymdownx.inlinehilite
|
||||
- pymdownx.snippets
|
||||
- md_in_html
|
||||
- pymdownx.superfences
|
||||
- pymdownx.tabbed:
|
||||
alternate_style: true
|
||||
# - pymdownx.emoji:
|
||||
# emoji_index: !!python/name:materialx.emoji.twemoji
|
||||
# emoji_generator: !!python/name:materialx.emoji.to_svg
|
||||
# options:
|
||||
# custom_icons:
|
||||
# - .icons
|
||||
|
||||
|
||||
|
Reference in New Issue
Block a user