105 lines
6 KiB
TOML
Executable file
105 lines
6 KiB
TOML
Executable file
[project]
|
||
copyright = "© Gugulethu Hlekwayo. All rights reserved."
|
||
docs_dir = "content"
|
||
extra_css = ["assets/css/theme.css"]
|
||
language = "en"
|
||
nav = [{ 'Homepage' = "index.md" }, { 'Resume' = "resume.md" }]
|
||
repo = "fontawesome/brands/git-alt"
|
||
repo_name = "g_it/gugulet.hu"
|
||
repo_url = "https://git.gugulet.hu/g_it/site"
|
||
site_author = "Gugulethu Hlekwayo"
|
||
site_description = "Gwabini, Bele elide, bhoya benyathi"
|
||
site_dir = "./deploy"
|
||
site_name = "Gugulethu Hlekwayo"
|
||
site_url = "https://gugulet.hu"
|
||
|
||
[project.extra]
|
||
generator = false
|
||
|
||
[project.markdown_extensions.admonition] # The Admonition extension adds support for admonitions, more commonly known as call-outs, which can be defined in Markdown by using a simple syntax.
|
||
|
||
[project.markdown_extensions.attr_list] # The Attribute Lists extension allows to add HTML attributes and CSS classes to almost every Markdown inline- and block-level element with a special syntax.
|
||
|
||
[project.markdown_extensions.def_list] # The [Definition Lists] extension adds the ability to add definition lists (more commonly known as description lists – dl in HTML) via Markdown to a document.
|
||
|
||
[project.markdown_extensions.footnotes] # The Footnotes extension allows to define inline footnotes, which are then rendered below all Markdown content of a document.
|
||
|
||
[project.markdown_extensions.md_in_html] # The Markdown in HTML extension allows for writing Markdown inside of HTML, which is useful for wrapping Markdown content with custom elements.
|
||
|
||
[project.markdown_extensions.pymdownx.arithmatex] # The Arithmatex extension allows for rendering of block and inline block equations and integrates seamlessly with MathJax1 – a library for mathematical typesetting.
|
||
generic = true
|
||
|
||
[project.markdown_extensions.pymdownx.blocks.caption] # The Caption extension adds the ability to add captions to any Markdown block, including images, tables, and code blocks.
|
||
|
||
[project.markdown_extensions.pymdownx.caret] # The caret extension allows the use of the ^ symbol.
|
||
|
||
[project.markdown_extensions.pymdownx.details] # The Details extension supercharges the Admonition extension, making the resulting call-outs collapsible, allowing them to be opened and closed by the user.
|
||
|
||
[project.markdown_extensions.pymdownx.emoji] # The Emoji extension automatically inlines bundled and custom icons and emojis in *.svg file format into the resulting HTML page.
|
||
emoji_index = "zensical.extensions.emoji.twemoji"
|
||
emoji_generator = "zensical.extensions.emoji.to_svg"
|
||
|
||
[project.markdown_extensions.pymdownx.highlight] # The Highlight extension adds support for syntax highlighting of code blocks.
|
||
anchor_linenums = true
|
||
auto_title = true
|
||
linenums_style = "pymdownx-inline"
|
||
pygments_lang_class = true
|
||
|
||
[project.markdown_extensions.pymdownx.inlinehilite] # The InlineHilite extension add support for syntax highlighting of inline code blocks.
|
||
|
||
[project.markdown_extensions.pymdownx.keys] # The Keys extension adds a simple syntax to allow for the rendering of keyboard keys and combinations.
|
||
|
||
[project.markdown_extensions.pymdownx.mark] # The mark extension allows the use of highlighting in text.
|
||
|
||
[project.markdown_extensions.pymdownx.smartsymbols] # The SmartSymbols extension converts some sequences of characters into their corresponding symbols.
|
||
# [project.markdown_extensions.pymdownx.snippets] # The Snippets extension adds the ability to add a small tooltip to an element, by wrapping it with an abbr tag.
|
||
# auto_append = ["content/includes/definitions.md"]
|
||
|
||
[project.markdown_extensions.pymdownx.superfences] # The SuperFences extension allows for arbitrary nesting of code and content blocks inside each other.
|
||
custom_fences = [
|
||
{ name = "mermaid", class = "mermaid", format = "pymdownx.superfences.fence_code_format" }
|
||
]
|
||
|
||
[project.markdown_extensions.pymdownx.tabbed] # The Tabbed extension allows the usage of content tabs, a simple way to group related content and code blocks under accessible tabs.
|
||
alternate_style = true
|
||
|
||
[project.markdown_extensions.pymdownx.tasklist] # The Tasklist extension allows for the usage of GitHub Flavored Markdown inspired task lists, following the same syntactical conventions.
|
||
custom_checkbox = true
|
||
|
||
[project.markdown_extensions.pymdownx.tilde] # The tilde extension allows the use of the ~ symbol.
|
||
|
||
[project.markdown_extensions.tables] # The Tables extension adds the ability to create tables in Markdown by using a simple syntax.
|
||
|
||
[project.markdown_extensions.toc] # The Table of Contents extension automatically generates a table of contents from a document, which Zensical will render as part of the resulting page.
|
||
permalink = true
|
||
|
||
[project.plugins.mkdocstrings.handlers.python] # mkdocstrings, which allows rendering API reference documentation from source code.
|
||
inventories = ["https://docs.python.org/3/objects.inv"]
|
||
paths = ["src"]
|
||
|
||
[project.plugins.mkdocstrings.handlers.python.options]
|
||
docstring_style = "google"
|
||
inherited_members = true
|
||
show_source = false
|
||
|
||
[project.plugins.offline] # The offline functionality makes sure that the site search works when you distribute the contents of your site directory as a download.
|
||
|
||
[project.theme]
|
||
custom_dir = "content/overrides"
|
||
language = "en"
|
||
palette.primary = "custom"
|
||
features = [
|
||
"content.action.view", # View source of this page.
|
||
"content.code.annotate", # Attach arbitrary content to specific sections of code blocks.
|
||
"content.code.copy", # A button on the right side to allow the user to copy a code block's contents to the clipboard.
|
||
"content.code.select", # A button to allow for the selection of line ranges by the user.
|
||
"content.footnote.tooltips", # Render footnotes as inline tooltips.
|
||
"content.tooltips", # Improves the default browser tooltips.
|
||
"navigation.indexes",
|
||
"navigation.instant", # Intercept links to behave like a Single-Page Application.
|
||
"navigation.instant.prefetch", # Pre-fetch page when user hovers over a link.
|
||
"navigation.instant.progress", # Show the page load progress.
|
||
"navigation.tracking", # Add the current section to the URL for tracking.
|
||
"search.highlight", # Highlight all search results after following the link.
|
||
]
|
||
variant = "modern"
|