diff --git a/docs/overrides/partials/footer.html b/docs/overrides/partials/footer.html index 0449435..1bc0620 100644 --- a/docs/overrides/partials/footer.html +++ b/docs/overrides/partials/footer.html @@ -1,8 +1,8 @@
- technicalvisualwriting + technicalvisualwriting
v202506.1
diff --git a/docs/resume.md b/docs/resume.md index c1f8622..02a8d51 100644 --- a/docs/resume.md +++ b/docs/resume.md @@ -7,8 +7,12 @@ hide: --- + + + +

hey, i'm gugulethu

@@ -35,6 +39,8 @@ hide:
+
+
-
+
@@ -59,7 +65,7 @@ body {
-
+
Current

Documentation Engineer

@@ -156,6 +162,9 @@ body {
JavaScript
+
+ TypeScript +
@@ -191,114 +200,104 @@ body {
-
-
-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Content types
- - - API documentation - Documented REST APIs and GraphQL. With REST APIs worked with a system where annotations in the source code automatically created the reference.
- - - Developer content - Created developer-focused documentation to create integrations and orchestrate services. For more, see Mambu Process Orchestrator.
- - - Hardware documentationDocumented Point-of-Sale (POS) devices for small business owners to use
- - - Technical theory -
- - - Task content -
- Reference content -
- - - Course content -
- - - Onboarding content -
- - - Scriptwriting -
- - - Academic writing -
- - - Content marketing -
-
-
-
+
+
+

Writing

+

Writing is my primary skill and I'm capable of writing in different formats using different mediums to persuade, teach, and engage. I've been writing professionally for over 15 years and privately since as far as memory can recall.

-
-
-

Writing

-

Writing is my primary skill and I'm capable of writing in different formats using different mediums to persuade, teach, and engage. I've been writing professionally for over 15 years and personaslly since as far as memory can recall.

+
+
+
    +
  • +
    + + + API documentation +
    +

    Documented REST APIs and GraphQL. With REST APIs worked with a system where annotations in the source code automatically created the reference.

    +
    • +
  • +
    + + + Developer content +
    +

    Created developer-focused documentation to create integrations with other financial services and orchestrate services.

    +
    Read developer docs
     +
    • +
  • +
    + + + Hardware documentation +
    +

    Documented Point-of-Sale (POS) devices for small business owners to use. This involved getting user feedback to understand how users were using the devices.

    +
    • +
  • +
    + + + Technical theory +
    +

    Created explainer content to give readers an understanding of concepts or ideas behind a tool,technology, or application.

    +
    See the overview docs
     +
    • +
  • +
    + + + Task content +
    +

    Documentation for performing actions and using a tool or an application.

    +
    Read the tutorial
     +
    • +
  • +
    + Reference content +
    +

    Reference content is like a dictionary: a term and its definition in a list. I've created glossaries and technical references for developers and non-developers.

    +
    • +
  • +
    + + + Course content +
    +

    I've created courses for more in-depth teaching that combines theory and practice in a set lesson plan.

    +
    Open the intro course
     +
    • +
  • +
    + + + Scriptwriting +
    +

    I have written and edited scripts for television and radio, including this advert. +

    + + + + +
    • + +
@@ -307,30 +306,72 @@ body {

Technical

-

The API References included old documentation that needed to maintenance for clients that had not yet migrated to the latest versions of the REST API.

+

As a one-man technical writing department, my technical skills are important to maintaining Documentation Operations (DocOps) and building infrastructure. I create, service, and maintain all the technical aspects of documentation.

+
+ Web development
html, js, css, sass, python, static site generators, node.js, yaml, appsmith
+
+
+ DocOps and automation
github workflows, vale linting, shell scripting, node red
+
+
+ Reading and writing code
js, python, json, xpath, yaml, openapi spec, graphql, markdown
+
+
+ Machine learning
ollama, deepseek, qwen, llama, openai, anthropic, agents, chatbots, rag, image generation, comfyui, openweb-ui
+
- + + + +
Built the documentation site of SPREAD.ai and the CI/CD pipeline and review automation process.
-
+
-
- +
+ ``` mermaid + sequenceDiagram + autonumber + ✍🏽 writer->>✍🏽 writer: Collect feedback + ✍🏽 writer->>✍🏽 writer: Brainstorm content ideas + ✍🏽 writer->>✍🏽 writer: Write draft content + ✍🏽 writer->>πŸ§‘πŸ½β€πŸ”§ technical expert: Check the draft for technical accuracy + πŸ§‘πŸ½β€πŸ”§ technical expert->>πŸ§‘πŸ½β€πŸ”§ technical expert: Check content + Note right of πŸ§‘πŸ½β€πŸ”§ technical expert: Identify issues with draft + πŸ§‘πŸ½β€πŸ”§ technical expert-->>✍🏽 writer: Revert with issues to fix + ✍🏽 writer->>✍🏽 writer: Fix issues and send back + πŸ§‘πŸ½β€πŸ”§ technical expert->>πŸ§‘πŸ½β€πŸ”§ technical expert: Check content + Note right of πŸ§‘πŸ½β€πŸ”§ technical expert: Pass content + πŸ§‘πŸ½β€πŸ”§ technical expert-->>✍🏽 writer: Return pass + ✍🏽 writer->>✍🏽 other writer: Check draft for language + ✍🏽 other writer->>✍🏽 other writer: Review language and understanding + Note right of ✍🏽 other writer: Note improvements + ✍🏽 other writer->>✍🏽 writer: Send notes for improvement + ✍🏽 writer->>✍🏽 writer: Make improvements + ✍🏽 writer->>πŸ€– automated check: Check using AI and/or Vale + πŸ€– automated check->>✍🏽 writer: Return fixes + ✍🏽 writer->>✍🏽 writer: Prepare and publish final draft + ```
+
An example of the documentation writing process.

Process

-

The API References included old documentation that needed to maintenance for clients that had not yet migrated to the latest versions of the REST API.

+

Publishing content, reviewing content, and managing a tehcnical writing team involves creating processes around people. As a team lead, I've had to define priorities for the documentation function; mentor and manage other writers; create writing and review processes; measure impact; and manage relationships with software engineering teams, marketing and sales, and executives.

+
+
Contact me
 +
+
diff --git a/docs/src/historical-approaches-vol7.pdf b/docs/src/historical-approaches-vol7.pdf new file mode 100755 index 0000000..5f4bca1 Binary files /dev/null and b/docs/src/historical-approaches-vol7.pdf differ diff --git a/docs/src/stylesheets/g.css b/docs/src/stylesheets/g.css index 8e49104..67130d2 100644 --- a/docs/src/stylesheets/g.css +++ b/docs/src/stylesheets/g.css @@ -43,6 +43,35 @@ article.md-content__inner.md-typeset:after { content: none; } +.md-typeset figcaption { + font-family: var(--secondary-font); + color: var(--tertiary-colour); + font-size: 0.8em; + font-style: normal; + max-width: none; +} + +.vds-title { + font-family: var(--secondary-font); + font-size: 0.8em; +} + +/***************************** +* BUTTON +*****************************/ + +div.button { + font-family: var(--secondary-font); + border-bottom: 3px solid var(--secondary-colour); + width: fit-content; + padding-bottom: 3px; + font-weight: bold; + + &:hover { + border-bottom: 3px solid white; + } +} + /***************************** * HERO TEXT *****************************/ @@ -354,7 +383,7 @@ div.tabbed-block { } } -div.tags { +.tags { font-size: max(9px, 0.8em); font-style: italic; color: var(--tertiary-colour); @@ -404,14 +433,53 @@ p.blurb { } /* Portfolio */ +.grid.cards { + + li { + background-color: var(--quarternary-colour); + border: none !important; + border-radius: 5px !important; + box-shadow: none; + padding: 2em !important; + margin: 2em !important; + + h6 { + text-transform: initial !important; + + span { + margin-right: 3px; + } + } + + &:hover { + box-shadow: none !important; + border: none !important; + } + } +} + +.writing { + padding: 4em; + + h6 { + font-size: max(calc(var(--text-variable-size) + 5px), calc(var(--text-min-size) + 2px)); + color: var(--primary-colour); + text-transform: uppercase; + margin-bottom: 8px; + } + + p { + font-size: max(calc(var(--text-variable-size) + 3px), var(--text-min-size)); + } +} + .two-column { display: grid; grid-template-columns: repeat(2, 1fr); max-width: 1500px; padding: 20px 20px 20px 0; width: 100%; - margin: 30px auto; - border-bottom: 1px solid var(--quarternary-colour); + margin: 10px auto; .column { display: flex; @@ -436,18 +504,31 @@ p.blurb { p { font-size: max(calc(var(--text-variable-size) + 3px), var(--text-min-size)); } + + div { + font-family: var(--secondary-font); + } } } } -div.md-typeset__table table { - font-family: var(--secondary-font); - font-size: max(calc(var(--text-variable-size) + 3px), calc(var(--text-min-size) + 2px)) !important; +/* Contact */ - thead { - font-weight: bold; - font-size: max(calc(var(--text-variable-size) + 7px), calc(var(--text-min-size) + 2px)) !important; - background-color: var(--quarternary-colour); +div.contact-me { + display: flex; + justify-content: center; + align-items: center; + + div.button { + font-size: 1.8em; + text-transform: uppercase; + font-weight: bold !important; + color: var(--tertiary-colour); + + &:hover { + border-bottom: 3px solid var(--tertiary-colour); + color: var(--secondary-colour); + } } } diff --git a/docs/src/windhoek-jazz-festival-50s.mp3 b/docs/src/windhoek-jazz-festival-50s.mp3 new file mode 100644 index 0000000..ab2985c Binary files /dev/null and b/docs/src/windhoek-jazz-festival-50s.mp3 differ diff --git a/docs/visual.md b/docs/visual.md index e7b4f0e..ddb9a6c 100644 --- a/docs/visual.md +++ b/docs/visual.md @@ -1,5 +1,7 @@ +:material-web: -| Content types | | | -| :--- | :--- | :--- | -| :material-school: Academic writing | | | -| :fontawesome-solid-paintbrush: Content marketing | | | +:material-code-json: + +:octicons-workflow-16: + +:material-robot: diff --git a/mkdocs.yml b/mkdocs.yml index bf3bcf4..7957335 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,155 +1,159 @@ -copyright: 'Β© Gugulethu Hlekwayo. All rights reserved.' +copyright: "Β© Gugulethu Hlekwayo. All rights reserved." exclude_docs: | - includes/ - overrides/ - readme.md + includes/ + overrides/ + readme.md extra: - generator: false - social: - - icon: material/web - link: https://gugulet.hu - - icon: material/git - link: https://codeberg.org/gugulethu - - icon: material/linkedin - link: https://www.linkedin.com/in/gugulet-hu - tags: - HTML: html - JavaScript: js - CSS: css - Python: python - Shell: shell - Manual: manual - Sync: sync - Logic: logic - Database: database - Collect: collect - Validate: validate - Display: display - Analyse: analyse - Predict: predict - Watch: watch - Mobile: mobile - Laptop: laptop + generator: false + social: + - icon: material/web + link: https://gugulet.hu + - icon: material/git + link: https://codeberg.org/gugulethu + - icon: material/linkedin + link: https://www.linkedin.com/in/gugulet-hu + tags: + HTML: html + JavaScript: js + CSS: css + Python: python + Shell: shell + Manual: manual + Sync: sync + Logic: logic + Database: database + Collect: collect + Validate: validate + Display: display + Analyse: analyse + Predict: predict + Watch: watch + Mobile: mobile + Laptop: laptop extra_css: - - src/stylesheets/g.css + - src/stylesheets/g.css markdown_extensions: - # Allows showing additional content on hover for glossaries. [https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/?h=abbr#abbreviations] - - abbr - # Allows the use of admonitions. [https://squidfunk.github.io/mkdocs-material/reference/admonitions/#admonitions] - - admonition - # Attribute lists. [https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/?h=attr+list#attribute-lists] - - attr_list - # Allows creating footonotes. [https://squidfunk.github.io/mkdocs-material/reference/footnotes/?h=footnotes#footnotes] - - footnotes - # Write Markdown in HTML. [https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/#markdown-in-html] - - md_in_html - # Improves handling of emphasis in MarkDown. [https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/?h=bet#betterem] - - pymdownx.betterem: - smart_enable: all - # Add captions to any block of content. [https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#caption] - - pymdownx.blocks.caption - # Enable carets in MarkDown. [https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/?h=bet#betterem] - - pymdownx.caret - # Add editing marks in the text using Markdown. [https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#critic] - - pymdownx.critic - # Makes admonitions collapsible. [https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#details] - - pymdownx.details - - pymdownx.emoji: - emoji_index: !!python/name:material.extensions.emoji.twemoji - emoji_generator: !!python/name:material.extensions.emoji.to_svg - # Allows code block highlighting. [https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/?h=highlig#highlight] - - pymdownx.highlight - # Built on pymdownx.highlight. Allows highlighting inline code. [https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/?h=inline#inlinehilite] - - pymdownx.inlinehilite - # Add keyboard keys in Markdown. [https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/?h=inline#keys] - - pymdownx.keys - # Allows highlight text in MarkDown. [https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/?h=bet#betterem] - - pymdownx.mark - # Add smart symbols, like copyright, in MarkDown. [https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/?h=smartsym#smartsymbols] - - pymdownx.smartsymbols - # Embed content and show it as a tooltip, liek for the definitions. [https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/?h=smartsym#snippets] - - pymdownx.snippets: - auto_append: - - includes/definitions.md # Path to definitions that appear in windows in the text. - # Used to target Mermaid diagrams for rendering. [https://squidfunk.github.io/mkdocs-material/upgrade/?h=superfen#pymdownxsuperfences] - - pymdownx.superfences: - custom_fences: - - name: mermaid - class: mermaid - format: !!python/name:mermaid2.fence_mermaid_custom - # Allows creating content tabs. [https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/?h=tabb#tabbed] - - pymdownx.tabbed: - alternate_style: true # This is the supported style. Works better on mobile view. - # Render tasklists with custom icons. [https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/?h=taskl#tasklist] - - pymdownx.tasklist: - custom_checkbox: true - #Allows tildes in MarkDown. [https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/?h=bet#betterem] - - pymdownx.tilde - - toc: - permalink: false - toc_depth: 2 + # Allows showing additional content on hover for glossaries. [https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/?h=abbr#abbreviations] + - abbr + # Allows the use of admonitions. [https://squidfunk.github.io/mkdocs-material/reference/admonitions/#admonitions] + - admonition + # Attribute lists. [https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/?h=attr+list#attribute-lists] + - attr_list + # Allows creating footonotes. [https://squidfunk.github.io/mkdocs-material/reference/footnotes/?h=footnotes#footnotes] + - footnotes + # Write Markdown in HTML. [https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/#markdown-in-html] + - md_in_html + # Improves handling of emphasis in MarkDown. [https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/?h=bet#betterem] + - pymdownx.betterem: + smart_enable: all + # Add captions to any block of content. [https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#caption] + - pymdownx.blocks.caption + # Enable carets in MarkDown. [https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/?h=bet#betterem] + - pymdownx.caret + # Add editing marks in the text using Markdown. [https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#critic] + - pymdownx.critic + # Makes admonitions collapsible. [https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#details] + - pymdownx.details + - pymdownx.emoji: + emoji_index: !!python/name:material.extensions.emoji.twemoji + emoji_generator: + !!python/name:material.extensions.emoji.to_svg # Allows code block highlighting. [https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/?h=highlig#highlight] + + + - pymdownx.highlight + # Built on pymdownx.highlight. Allows highlighting inline code. [https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/?h=inline#inlinehilite] + - pymdownx.inlinehilite + # Add keyboard keys in Markdown. [https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/?h=inline#keys] + - pymdownx.keys + # Allows highlight text in MarkDown. [https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/?h=bet#betterem] + - pymdownx.mark + # Add smart symbols, like copyright, in MarkDown. [https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/?h=smartsym#smartsymbols] + - pymdownx.smartsymbols + # Embed content and show it as a tooltip, liek for the definitions. [https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/?h=smartsym#snippets] + - pymdownx.snippets: + auto_append: + - includes/definitions.md # Path to definitions that appear in windows in the text. + # Used to target Mermaid diagrams for rendering. [https://squidfunk.github.io/mkdocs-material/upgrade/?h=superfen#pymdownxsuperfences] + - pymdownx.superfences: + custom_fences: + - name: mermaid + class: mermaid + format: + !!python/name:mermaid2.fence_mermaid_custom # Allows creating content tabs. [https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/?h=tabb#tabbed] + + + - pymdownx.tabbed: + alternate_style: true # This is the supported style. Works better on mobile view. + # Render tasklists with custom icons. [https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/?h=taskl#tasklist] + - pymdownx.tasklist: + custom_checkbox: true + #Allows tildes in MarkDown. [https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/?h=bet#betterem] + - pymdownx.tilde + - toc: + permalink: false + toc_depth: 2 nav: - - Homepage: index.md - - Writing: writing.md - - Visual: visual.md - - Technical: - - technical.md - - Qself: - - qself/qself.md - - Getting started: qself/getting-started.md - - Finances: qself/finances.md - - Transactions: qself/transactions.md - - Reference: qself/reference/index.md - - Devices: qself/devices.md - - ResumΓ©: resume.md + - Homepage: index.md + # - Writing: writing.md + # - Visual: visual.md + # - Technical: + # - technical.md + # - Qself: + # - qself/qself.md + # - Getting started: qself/getting-started.md + # - Finances: qself/finances.md + # - Transactions: qself/transactions.md + # - Reference: qself/reference/index.md + # - Devices: qself/devices.md + - ResumΓ©: resume.md plugins: - # Plugin to enable the blog feature. [https://squidfunk.github.io/mkdocs-material/setup/setting-up-a-blog/#built-in-blog-plugin] - - blog - # Plugin to display a lightbox for clicked images. [https://github.com/Blueswen/mkdocs-glightbox] - - glightbox: - background: white - shadow: false - width: 100% - height: auto - slide_effect: fade - manual: true - # Plugin to use variables and macros across the docs. [https://github.com/fralau/mkdocs-macros-plugin] - - macros: - on_undefined: strict - include_yaml: - - snippets: docs/includes/snippets.yml - # Plugin to display mermaid diagrams. [https://mkdocs-mermaid2.readthedocs.io/en/latest/] - - mermaid2 - # Plugin that minifies all HTML, CSS, and JS files. [https://github.com/byrnereese/mkdocs-minify-plugin] - - minify: - minify_html: true - minify_js: true - minify_css: true - htmlmin_opts: - remove_comments: true - cache_safe: true - # Plugin to self-host external assets and for link attributes. [https://squidfunk.github.io/mkdocs-material/plugins/privacy/] - - privacy: - links_attr_map: - target: _blank # Open external links in a new page. - assets_exclude: - - cdn.jsdelivr.net/npm/mathjax@3/* - - search - # Plugin to create index pages for each section. [https://github.com/oprypin/mkdocs-section-index] - - section-index - # Plugin to manage social media cards. Requires installing: pip install "mkdocs-material[imaging] - - social: - cards: true - cards_layout_options: - background_color: "#828089" - font_family: Libre Baskerville - - tags + # Plugin to enable the blog feature. [https://squidfunk.github.io/mkdocs-material/setup/setting-up-a-blog/#built-in-blog-plugin] + - blog + # Plugin to display a lightbox for clicked images. [https://github.com/Blueswen/mkdocs-glightbox] + - glightbox: + background: white + shadow: false + width: 100% + height: auto + slide_effect: fade + manual: true + # Plugin to use variables and macros across the docs. [https://github.com/fralau/mkdocs-macros-plugin] + - macros: + on_undefined: strict + include_yaml: + - snippets: docs/includes/snippets.yml + # Plugin to display mermaid diagrams. [https://mkdocs-mermaid2.readthedocs.io/en/latest/] + - mermaid2 + # Plugin that minifies all HTML, CSS, and JS files. [https://github.com/byrnereese/mkdocs-minify-plugin] + - minify: + minify_html: true + minify_js: true + minify_css: true + htmlmin_opts: + remove_comments: true + cache_safe: true + # Plugin to self-host external assets and for link attributes. [https://squidfunk.github.io/mkdocs-material/plugins/privacy/] + - privacy: + links_attr_map: + target: _blank # Open external links in a new page. + assets_exclude: + - cdn.jsdelivr.net/npm/mathjax@3/* + - search + # Plugin to create index pages for each section. [https://github.com/oprypin/mkdocs-section-index] + - section-index + # Plugin to manage social media cards. Requires installing: pip install "mkdocs-material[imaging] + - social: + cards: true + cards_layout_options: + background_color: "#828089" + font_family: Libre Baskerville + - tags repo_name: gugulet-hu/gugulet.hu @@ -161,64 +165,64 @@ site_description: The personal website of Gugulethu Hlekwayo. site_name: Gugulethu Hlekwayo -site_url: 'https://gugulet.hu' +site_url: "https://gugulet.hu" theme: - # Folder where there are files that override aspects of the site. - custom_dir: docs/overrides/ - # Link to the favicon image file. - favicon: src/gugulet.hu-site-logo-350x350.png - features: - - content.action.edit # Edit page directly from the GitHub link iun the top-right. - - content.code.annotate # Annotate code blocks. - - content.code.copy # Copy code blocks. - - content.code.select # Select code range in blocks (*). - - navigation.expand # Expand the navigation by default. - - navigation.path # Add breadcrumbs to the top of the article. - - navigation.prune # Only the visible pages are in the menu. - - navigation.tabs # Tabs at the top for the chapters (i.e Platform Admin, Platform Tools, ...). - - navigation.tracking # Address bar updated with active anchor. - - navigation.top # Back to the top button on every page. - - navigation.footer # Previous and next buttons in the footer. - - search.highlight # Highlight the search item in the page. - - search.suggest # Suggest search results. - - search.share # Deep-link to a search results page. - font: - text: Libre Baskerville - code: DM Mono - # Icons to use for different tags and the repo. - icon: - annotation: material/plus-circle-outline - repo: material/git - tag: - analyse: material/finance - collect: material/collapse-all - css: material/language-css3 - database: material/database - display: material/fit-to-screen - html: material/language-html5 - js: material/language-javascript - laptop: material/laptop - logic: material/robot - manual: material/wheel-barrow - mobile: material/cellphone-cog - predict: material/crystal-ball - python: material/language-python - shell: material/console - sync: material/sync-circle - validate: material/check-decagram - watch: material/watch - language: en - logo: src/gugulet.hu-site-logo-350x350.png - name: material - palette: - scheme: default - primary: custom - accent: custom + # Folder where there are files that override aspects of the site. + custom_dir: docs/overrides/ + # Link to the favicon image file. + favicon: src/gugulet.hu-site-logo-350x350.png + features: + - content.action.edit # Edit page directly from the GitHub link iun the top-right. + - content.code.annotate # Annotate code blocks. + - content.code.copy # Copy code blocks. + - content.code.select # Select code range in blocks (*). + - navigation.expand # Expand the navigation by default. + - navigation.path # Add breadcrumbs to the top of the article. + - navigation.prune # Only the visible pages are in the menu. + - navigation.tabs # Tabs at the top for the chapters (i.e Platform Admin, Platform Tools, ...). + - navigation.tracking # Address bar updated with active anchor. + - navigation.top # Back to the top button on every page. + - navigation.footer # Previous and next buttons in the footer. + - search.highlight # Highlight the search item in the page. + - search.suggest # Suggest search results. + - search.share # Deep-link to a search results page. + font: + text: Libre Baskerville + code: DM Mono + # Icons to use for different tags and the repo. + icon: + annotation: material/plus-circle-outline + repo: material/git + tag: + analyse: material/finance + collect: material/collapse-all + css: material/language-css3 + database: material/database + display: material/fit-to-screen + html: material/language-html5 + js: material/language-javascript + laptop: material/laptop + logic: material/robot + manual: material/wheel-barrow + mobile: material/cellphone-cog + predict: material/crystal-ball + python: material/language-python + shell: material/console + sync: material/sync-circle + validate: material/check-decagram + watch: material/watch + language: en + logo: src/gugulet.hu-site-logo-350x350.png + name: material + palette: + scheme: default + primary: custom + accent: custom # Properties to validate and return messages for in the build process. validation: - nav: - absolute_links: ignore - not_found: warn - omitted_files: ignore + nav: + absolute_links: ignore + not_found: warn + omitted_files: ignore