katenary/doc/mkdocs.yml

site_name: Katenary documentation
docs_dir: ./docs
plugins: 
  - search
  - inline-svg
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
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://github.com/metal3d/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/parser.md
    - packages/update.md
    - packages/utils.md
    - Generator: 
      - Index: packages/generator.md
      - ExtraFiles: packages/generator/extrafiles.md
      - LabelStructs: packages/generator/labelStructs.md
Add site_dirs 2022-06-13 13:50:57 +02:00			`site_name: Katenary documentation`
			`docs_dir: ./docs`
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			`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`
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`
			`- pymdownx.superfences`
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`
			`link: https://github.com/metal3d/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:`
			`- 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:`
Fixup documentation - better gomarkdown generation that now fixed the escaped strings, no need to use pandoc anymore - added workflow image - upgraded versions of mkdocs requirements 2024-04-10 04:51:45 +02:00			`- packages/cmd/katenary.md`
Go to Katenary V3 This is the next-gen of Katenary 2023-12-06 15:24:02 +01:00			`- packages/parser.md`
			`- packages/update.md`
			`- packages/utils.md`
Use real types to parse labels We were using `yaml.Unmarshal` on basic types or inline structs. This was not efficient and not clear to defined what we expect in labels. We now use types to unmarshal the labels. Only the `values` label is, at this time, parsed by GetValuesFromLabel because this `utils` function is clearly a special case. 2024-04-24 23:06:45 +02:00			`- Generator:`
			`- Index: packages/generator.md`
			`- ExtraFiles: packages/generator/extrafiles.md`
			`- LabelStructs: packages/generator/labelStructs.md`