Glenn Y. Rolland
d4924377fe
Improves the maintainability and clarity of the documentation assets by restructuring directories and refining CSS rules. - Rename CSS and JavaScript directories for better asset organization. - Add CSS rules to hide elements with 'bc-docs-hidden' attribute, enhancing document customization. - Comment out specific content in CSS header to simplify text display. - Remove outdated UML mindmap file to clean up unused resources. - Comment out 'md_in_html' extension in mkdocs configuration to streamline markdown processing. Signed-off-by: Glenn Y. Rolland <glenux@glenux.net>
102 lines
2 KiB
YAML
102 lines
2 KiB
YAML
---
|
|
site_name: Teaching Boilerplate
|
|
site_dir: _build/docs
|
|
|
|
# theme_dir: 'themes/mkdocs-material/material'
|
|
# theme_dir: 'themes/mkdocs-material'
|
|
|
|
site_author: 'Glenn Y. Rolland'
|
|
site_url: 'https://glenux.net'
|
|
|
|
# copyright: 'Copyright (c) 2016 Glenux'
|
|
|
|
repo_name: 'Source'
|
|
repo_url: ''
|
|
# https://bitbucket.com/glenux-corp/teaching-boilerplate'
|
|
# site_favicon: 'favicon.ico'
|
|
|
|
theme:
|
|
language: fr
|
|
# name: 'gitbook'
|
|
# name: 'alabaster'
|
|
# name: 'windmill'
|
|
# name: 'ivory'
|
|
name: 'material'
|
|
palette:
|
|
primary: 'white'
|
|
accent: 'black'
|
|
neutral: 'black'
|
|
features:
|
|
- navigation.sections
|
|
- navigation.footer
|
|
# - navigation.tabs
|
|
# - navigation.tabs.sticky
|
|
|
|
i18n:
|
|
prev: 'Chapitre précédent'
|
|
next: 'Chapitre suivant'
|
|
|
|
extra_css:
|
|
- css/extra.css
|
|
- ../docs.assets/css/extra.css
|
|
# - css/source.css
|
|
# - css/patch.css
|
|
|
|
extra_javascript:
|
|
- js/extra.js
|
|
- ../docs.assets/javascript/mathjax.js
|
|
- https://polyfill.io/v3/polyfill.min.js?features=es6
|
|
- https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
|
|
# - ../docs.assets/javascript/extra.js
|
|
|
|
# author:
|
|
# github: 'glenux'
|
|
# twitter: 'glenux'
|
|
|
|
# Extensions
|
|
markdown_extensions:
|
|
- footnotes
|
|
- admonition
|
|
# - md_in_html
|
|
- toc:
|
|
permalink: '#'
|
|
|
|
# https://squidfunk.github.io/mkdocs-material/reference/code-blocks/
|
|
- pymdownx.highlight:
|
|
anchor_linenums: false
|
|
- pymdownx.inlinehilite
|
|
- codehilite:
|
|
guess_lang: true
|
|
|
|
# pip install mdx_truly_sane_lists
|
|
- mdx_truly_sane_lists
|
|
|
|
# pip install pymdown-extensions
|
|
- pymdownx.emoji:
|
|
emoji_generator: !!python/name:pymdownx.emoji.to_svg
|
|
#
|
|
# pip install pymdown-extensions
|
|
- pymdownx.superfences:
|
|
# - pymdownx.arithmatex:
|
|
# generic: true
|
|
|
|
# plugins: []
|
|
plugins:
|
|
- include-markdown
|
|
- awesome-pages
|
|
- pdf-export:
|
|
verbose: true
|
|
media_type: print
|
|
enabled_if_env: ENABLE_PDF_EXPORT
|
|
combined: false
|
|
|
|
extra:
|
|
search:
|
|
language: 'fr, en'
|
|
|
|
# run the following line to update toc
|
|
# pipenv run ./script/update-toc
|
|
|
|
# BEGIN MKDOCS-TOC
|
|
nav:
|
|
# END MKDOCS-TOC
|