docs-portfolio/mkdocs.yml at main · luisjguedes/docs-portfolio · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
site_name: Docs Portfolio — Luís Guedes da Silva
site_description: Selected technical documentation samples (structured docs, API docs, diagrams, docs-as-code workflow).

repo_name: luisjguedes/docs-portfolio
repo_url: https://github.com/luisjguedes/docs-portfolio
edit_uri: edit/main/docs/

nav:
  - Home: index.md
  - Start here: getting-started.md
  - Documentation approach:
      - Mental model: concepts/mental-model.md
      - Workflow diagram: concepts/workflow-diagram.md
      - What is an API?: concepts/what-is-an-api.md
      - Event Intake API (concept): concepts/event-intake.md
      - Docs strategy: strategy/docs-strategy.md
  - Contributing:
      - Markdown guide: contributing/markdown-guide.md
      - Style guide: contributing/style-guide.md
  - How-to guides:
      - Build a simple workflow: how-to/create-workflow.md
      - Send your first event: how-to/send-first-event.md
  - API documentation:
      - API reference: reference/api.md
      - Event Intake API: reference/event-intake-api.md
  - Troubleshooting:
      - Common issues: troubleshooting/common-issues.md
      - Event Intake API issues: troubleshooting/event-intake.md

plugins:
  - search
  - minify:
      minify_html: true

theme:
  name: material
  language: en
  features:
    - navigation.instant
    - navigation.tabs
    - navigation.top
    - navigation.sections
    - navigation.tracking
    - navigation.indexes
    - search.suggest
    - search.highlight
    - content.code.copy
    - toc.follow
  palette:
    - scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    - scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode

markdown_extensions:
  - admonition
  - toc:
      permalink: true
      title: On this page
  - tables
  - attr_list
  - md_in_html
  - pymdownx.details
  - pymdownx.highlight
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true

extra_javascript:
  - https://unpkg.com/mermaid@10/dist/mermaid.min.js
  - javascripts/mermaid-init.js

extra_css:
  - stylesheets/extra.css