documentation/mkdocs.yml

127 lines
3.5 KiB
YAML

site_name: Tristan Programming Language
# TODO: Fix the site url such that the blogging plugin shuts up
# site_url: http://journal/
# TODO: We must host fonts locally
# https://t.pxeger.com/mkdocs-material/setup/changing-the-fonts/
repo_url: http://deavmi.assigned.network/git/tlang/tlang
repo_name: tlang/tlang
nav:
- Home: index.md
- Introduction:
- Why: introduction/11-why.md
- Aims: introduction/12-aims.md
- Language:
- Introduction: language/30-index.md
- Grammar: language/31-grammar.md
- Comments: language/32-comments.md
- Literals: language/33-literals.md
- Types: language/34-types.md
- Variables: language/35-variables.md
- Conditionals: language/36-conditionals.md
- Loops: language/37-loops.md
- Funtions: language/38-functions.md
- Arrays: language/39-arrays.md
- Pointers: language/40-pointers.md
- Extern: language/44-extern.md
- Structs: language/41-structs.md
- OOP: language/42-oop.md
- Modules: language/43-modules.md
- Annotations: language/45-annotations.md
- Configuration: language/50-configuration.md
- Implementation:
- Introduction: implementation/30-introduction.md
- Lexical analysis: implementation/31-lexical.md
- Parsing: implementation/32-parsing.md
- Naming: implementation/33-naming.md
- Resolution: implementation/33-resolution.md
- Dependency generation: implementation/34-dependency.md
- Typechecking and codegen: implementation/35-typechecking.md
- Emit: implementation/36-emit.md
- Compiler: implementation/37-compiler.md
- Meta: implementation/38-meta.md
- Module management: implementation/39-modman.md
# - Journal:
# - Why: journal/why.md
# - First day: journal/first-day.md
# - First update: journal/update-1.md
# - Parsing begins: journal/parsing-begins.md
# - Parsing Update 1: journal/parser-update-1.md
# - Parsing Update 2: journal/parser-update-2.md
# - Why: journal/why.md
# - Why: journal/why.md
# - Why: journal/why.md
# - Why: journal/why.md
# - Dependency generation: journal/deps.md
# - Path-hopping: journal/deps_next.md
# - 2K22: journal/2K22.md
# - July Updates: journal/jul_updates.md
# - Code emitter: journal/code_emitter.md
# - Why: journal/why.md
# - Why: journal/why.md
theme:
name: bootstrap-classic
logo: logo.png
favicon: logo.png
features:
- search.highlight
palette:
primary: indigo
plugins:
- search
- exclude:
glob:
- docs/00-bookindex.md
#TODO: See if we can get git commit authors automatically on each page
#TODO: See if we can ehnace material docs theme
extra_css:
- css/hint.min.css
markdown_extensions:
- pymdownx.caret
- pymdownx.mark
- pymdownx.tilde
- pymdownx.arithmatex:
generic: true
- pymdownx.highlight:
anchor_linenums: true
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.tabbed:
alternate_style: true
- admonition
- pymdownx.details
- pymdownx.tasklist:
custom_checkbox: true
- attr_list
# - pymdownx.emoji:
# emoji_index: !!python/name:materialx.emoji.twemoji
# emoji_generator: !!python/name:materialx.emoji.to_svg
extra_javascript:
- javascripts/mathjax.js
- https://polyfill.io/v3/polyfill.min.js?features=es6
- https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js