katenary/doc/mkdocs.yml

site_name: Katenary documentation
docs_dir: ./docs
plugins:
  - search
  - inline-svg
  - manpage:
      enabled: !ENV [MANPAGE, false]
      preprocess: preprocess.py
      pages:
        - title: Katenary
          header: Katenary helm chart generator
          output: share/man/man1/katenary.1
          inputs:
            - usage.md
            - labels.md
theme:
  name: material
  custom_dir: overrides
  logo: statics/logo-bright.svg
  favicon: statics/icon.svg
  palette:
    - scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

    - scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
markdown_extensions:
  - admonition
  - footnotes
  - attr_list
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
      anchor_linenums: true
      use_pygments: false
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
extra_css:
  - statics/main.css
extra_javascript:
  - statics/addons.js
copyright: Copyright &copy; 2021 - 2024 - Katenary authors
extra:
  generator: false
  social:
    - icon: fontawesome/brands/github
      link: https://repo.katenary.io/katenary/katenary
nav:
  - "Home": index.md
  - usage.md
  - labels.md
  - Behind the scene:
      - coding.md
      - dependencies.md
  - FAQ: faq.md
  - Go Packages:
      - packages/cmd/katenary.md
      - packages/internal/parser.md
      - packages/internal/utils.md
      - Generator:
          - Index: packages/internal/generator.md
          - ExtraFiles: packages/internal/generator/extrafiles.md
          - labels:
              - packages/internal/generator/labels.md
              - Labelstructs: packages/internal/generator/labels/labelstructs.md
          - KatenaryFile: packages/internal/generator/katenaryfile.md
Add site_dirs 2022-06-13 13:50:57 +02:00			`site_name: Katenary documentation`
			`docs_dir: ./docs`
fix(doc): Fixing duplicated package 2025-07-07 21:57:14 +02:00			`plugins:`
Add footnotes and search 2024-04-19 12:11:18 +02:00			`- search`
Better styles, logo, effects... - Make a SVG with classes to invert the color of strokes - Set a better logo + one vertical 2024-04-10 22:25:07 +02:00			`- inline-svg`
feat(package): Add RPM, deb, pacman and tar packages and manpage Build package using fpm. As I don't want ruby/gem in my computer, the build system creates an OCI image with Podman (at this time), and generate dist pacakges. To enhance the packages, a manpage is now generated from the documentation. 2025-07-09 14:11:46 +02:00			`- manpage:`
			`enabled: !ENV [MANPAGE, false]`
			`preprocess: preprocess.py`
			`pages:`
			`- title: Katenary`
			`header: Katenary helm chart generator`
			`output: share/man/man1/katenary.1`
			`inputs:`
			`- usage.md`
			`- labels.md`
Add site_dirs 2022-06-13 13:50:57 +02:00			`theme:`
Better doc for ReadTheDocs 2022-06-14 09:25:43 +02:00			`name: material`
Fixup styles 2022-06-14 10:08:22 +02:00			`custom_dir: overrides`
Change doc, icon and logo 2024-04-10 13:53:58 +02:00			`logo: statics/logo-bright.svg`
			`favicon: statics/icon.svg`
Fixup styles 2022-06-14 10:08:22 +02:00			`palette:`
			`- scheme: slate`
			`toggle:`
			`icon: material/brightness-4`
			`name: Switch to light mode`

			`- scheme: default`
			`toggle:`
			`icon: material/brightness-7`
			`name: Switch to dark mode`
Better doc for ReadTheDocs 2022-06-14 09:25:43 +02:00			`markdown_extensions:`
			`- admonition`
Add footnotes and search 2024-04-19 12:11:18 +02:00			`- footnotes`
Better doc for ReadTheDocs 2022-06-14 09:25:43 +02:00			`- attr_list`
			`- pymdownx.emoji:`
Go to Katenary V3 This is the next-gen of Katenary 2023-12-06 15:24:02 +01:00			`emoji_index: !!python/name:material.extensions.emoji.twemoji`
			`emoji_generator: !!python/name:material.extensions.emoji.to_svg`
Better doc for ReadTheDocs 2022-06-14 09:25:43 +02:00			`- pymdownx.highlight:`
			`anchor_linenums: true`
			`use_pygments: false`
Enhance documentation - upgraded mkdocs and dependencise (+ add mermaid) - linted markdown - add more details 2024-10-18 09:34:57 +02:00			`- pymdownx.superfences:`
			`custom_fences:`
			`- name: mermaid`
			`class: mermaid`
			`format: !!python/name:pymdownx.superfences.fence_code_format`
Add site_dirs 2022-06-13 13:50:57 +02:00			`extra_css:`
			`- statics/main.css`
			`extra_javascript:`
			`- statics/addons.js`
Change doc, icon and logo 2024-04-10 13:53:58 +02:00			`copyright: Copyright © 2021 - 2024 - Katenary authors`
Fixup styles 2022-06-14 10:08:22 +02:00			`extra:`
			`generator: false`
			`social:`
			`- icon: fontawesome/brands/github`
feat(repo): Go to repo.katenary.io 2025-08-19 23:09:50 +02:00			`link: https://repo.katenary.io/katenary/katenary`
Add site_dirs 2022-06-13 13:50:57 +02:00			`nav:`
Better doc for ReadTheDocs 2022-06-14 09:25:43 +02:00			`- "Home": index.md`
Add site_dirs 2022-06-13 13:50:57 +02:00			`- usage.md`
Better doc for ReadTheDocs 2022-06-14 09:25:43 +02:00			`- labels.md`
Go to Katenary V3 This is the next-gen of Katenary 2023-12-06 15:24:02 +01:00			`- Behind the scene:`
fix(doc): Fixing duplicated package 2025-07-07 21:57:14 +02:00			`- coding.md`
			`- dependencies.md`
Add footnotes and search 2024-04-19 12:11:18 +02:00			`- FAQ: faq.md`
Go to Katenary V3 This is the next-gen of Katenary 2023-12-06 15:24:02 +01:00			`- Go Packages:`
fix(doc): Fixing duplicated package 2025-07-07 21:57:14 +02:00			`- packages/cmd/katenary.md`
feat(refacto): move everything in internal package This allows to install katenary with `go install` and to clean up the project folder. 2025-08-03 15:54:58 +02:00			`- packages/internal/parser.md`
			`- packages/internal/utils.md`
fix(doc): Fixing duplicated package 2025-07-07 21:57:14 +02:00			`- Generator:`
feat(refacto): move everything in internal package This allows to install katenary with `go install` and to clean up the project folder. 2025-08-03 15:54:58 +02:00			`- Index: packages/internal/generator.md`
			`- ExtraFiles: packages/internal/generator/extrafiles.md`
fix(doc): Fixing duplicated package 2025-07-07 21:57:14 +02:00			`- labels:`
feat(refacto): move everything in internal package This allows to install katenary with `go install` and to clean up the project folder. 2025-08-03 15:54:58 +02:00			`- packages/internal/generator/labels.md`
			`- Labelstructs: packages/internal/generator/labels/labelstructs.md`
			`- KatenaryFile: packages/internal/generator/katenaryfile.md`