Variables↵
Context↵
[(0, 'Page', "Page(title='Home', url='index.html')"), (1, 'Page', "Page(title='Demonstration', url='demo.html')"), (2, 'Section', "title = 'Extra', children = [Page(title='Variables', url='vars.html'), Page(title='Revision', url='revision.html')], _Section__active = False"), (3, 'Page', "Page(title='Download', url='download.html')")]
Page↵
Variable | Type | Content |
---|---|---|
file | File | src_uri = 'vars.md', src_dir = '/docs/source/docs', dest_dir = '/docs/source/site', use_directory_urls = False, inclusion [InclusionLevel], name = 'vars', dest_uri = 'vars.html', page [Page], abs_src_path = '/docs/source/docs/vars.md', url = 'vars.html' |
title | str | 'Variables' |
children | NoneType | None |
previous_page | Page | Page(title='Demonstration', url='demo.html') |
next_page | Page | Page(title='Revision', url='revision.html') |
_Page__active | bool | False |
update_date | str | '2024-06-25' |
canonical_url | NoneType | None |
abs_url | NoneType | None |
edit_url | str | 'https://github.com/majkinetor/mm-docs-template/edit/master/source/docs/vars.md' |
markdown | str | "# {{ page.title }}\n\n## Context\n\n{{ context(navigation) }}\n\n## Page\n\n{{ context(page) | pretty }}\n\n## Config\n\n{{ context(config) | pretty }}\n\nFrontmatter var - foo: {{ page.meta.foo }}\n\n{% include 'footer.md' %}" |
_title_from_render | NoneType | None |
content | NoneType | None |
toc | list | [] |
meta | dict | title = 'Variables', foo = 'bar' |
parent | Section | title = 'Extra', children = [Page(title='Variables', url='vars.html'), Page(title='Revision', url='revision.html')], _Section__active = False |
Config↵
Variable | Type | Content |
---|---|---|
config_file_path | str | '/docs/source/mkdocs.yml' |
site_name | str | 'MM-DOCS' |
nav | list | [{'Home': 'index.md'}, {'Demonstration': 'demo.md'}, {'Extra': [{'Variables': 'vars.md'}, {'Revision': 'revision.md'}]}, {'Download': 'download.md'}] |
pages | NoneType | None |
exclude_docs | NoneType | None |
draft_docs | NoneType | None |
not_in_nav | NoneType | None |
site_url | NoneType | None |
site_description | str | 'MM-DOCS Template' |
site_author | str | 'majkinetor' |
theme | Theme | Theme(name='material', dirs=['/docs/source/overrides', '/usr/lib/python3.12/site-packages/material/templates', '/usr/lib/python3.12/site-packages/mkdocs/templates'], static_templates={'404.html', 'sitemap.xml'}, name='material', locale=Locale('en'), language='en', direction=None, features=['navigation.expand', 'navigation.top', 'navigation.indexes', 'navigation.footer', 'content.action.edit', 'search.highlight', 'search.suggest'], font={'text': 'Roboto', 'code': 'Roboto Mono'}, icon=None, favicon='assets/images/favicon.png', palette=[{'scheme': 'default', 'toggle': {'icon': 'material/lightbulb-outline', 'name': 'Switch to dark mode'}}, {'scheme': 'slate', 'toggle': {'icon': 'material/lightbulb', 'name': 'Switch to light mode'}}]) |
docs_dir | str | '/docs/source/docs' |
site_dir | str | '/docs/source/site' |
copyright | str | '© majkinetor 2019' |
google_analytics | NoneType | None |
dev_addr | _IpAddressValue | _IpAddressValue(host='0.0.0.0', port=8000) |
use_directory_urls | bool | False |
repo_url | str | 'https://github.com/majkinetor/mm-docs-template' |
repo_name | str | 'GitHub' |
edit_uri_template | NoneType | None |
edit_uri | str | 'edit/master/source/docs/' |
extra_css | list | ['_extra/css/extra.css', '_extra/css/pdf.css'] |
extra_javascript | list | ['_extra/js/mathjax.js', '_extra/js/tablesort.js', 'https://polyfill.io/v3/polyfill.min.js?features=es6', 'https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js', 'https://unpkg.com/tablesort@5.3.0/dist/tablesort.min.js'] |
extra_templates | list | [] |
markdown_extensions | list | ['toc', 'tables', 'fenced_code', 'abbr', 'admonition', 'attr_list', 'codehilite', 'def_list', 'footnotes', 'md_in_html', 'meta', 'sane_lists', 'pymdownx.arithmatex', 'pymdownx.betterem', 'pymdownx.caret', 'pymdownx.critic', 'pymdownx.details', 'pymdownx.emoji', 'pymdownx.inlinehilite', 'pymdownx.keys', 'pymdownx.magiclink', 'pymdownx.mark', 'pymdownx.superfences', 'pymdownx.smartsymbols', 'pymdownx.tabbed', 'pymdownx.tasklist', 'pymdownx.tilde', 'markdown_include.include', 'plantuml_markdown'] |
mdx_configs | dict | toc [dict], pymdownx.arithmatex [dict], pymdownx.betterem [dict], pymdownx.emoji [dict], pymdownx.superfences [dict], pymdownx.tabbed [dict], pymdownx.tasklist [dict], markdown_include.include [dict] |
strict | bool | False |
remote_branch | str | 'gh-pages' |
remote_name | str | 'origin' |
extra | LegacyConfig | {'url_prefix': None, 'version': 0.1, 'company': {'name': 'Acme'}, 'social': [{'icon': 'dummy value to show social override'}], 'polyfills': ['https://unpkg.com/iframe-worker/shim']} |
plugins | PluginCollection | material/offline [OfflinePlugin], exclude [Exclude], macros [MacrosPlugin], material/search [SearchPlugin], material/tags [TagsPlugin], pdf-export [PdfExportPlugin], print-site [PrintSitePlugin] |
hooks | dict | |
watch | list | [] |
validation | Validation | {'nav': {'omitted_files': 20, 'not_found': 30, 'absolute_links': 20}, 'links': {'not_found': 30, 'absolute_links': 20, 'unrecognized_links': 20, 'anchors': 20}} |
Frontmatter var - foo: bar
✏️ Last Change: 2024-06-25 11:37
📖 Publication Date: 2024-06-25 11:38