draftjs_exporter/mkdocs.yml at main · wagtail/draftjs_exporter · 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
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
site_name: Draft.js exporter
repo_url: https://github.com/wagtail/draftjs_exporter
site_url: https://wagtail.github.io/draftjs_exporter/
edit_uri: edit/main/docs/

# Theme templates share a directory with theme assets, but are not site content.
exclude_docs: |
  theme/*.html
  theme/sitemap.xml

site_description: Library to convert rich text from Draft.js raw ContentState to HTML.
repo_name: draftjs_exporter
dev_addr: localhost:8001
theme:
  name: material
  font: false
  logo: theme/favicon.png
  favicon: theme/favicon.png
  palette:
    scheme: default
    primary: white
  features:
    - content.code.copy
  custom_dir: docs/theme
markdown_extensions:
  - admonition
  - sane_lists
  - toc:
      permalink: true
  - pymdownx.details
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.magiclink
  - pymdownx.superfences
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde
plugins:
  - search
  - git-revision-date-localized:
      enable_creation_date: true
      type: date
  - llmstxt:
      full_output: llms-full.txt
      # Only add docs pages that are relevant to users of the project.
      sections:
        Usage documentation:
          - index.md
          - getting-started.md
          - content-state.md
          - markdown.md
          - markdown-importer.md
          - migration-guide.md
        Guides:
          - guides/custom-components.md
          - guides/fallback-components.md
          - guides/alternative-engines.md
          - guides/custom-engines.md
        Reference:
          - reference/api.md
          - reference/configuration.md
          - reference/example.md
  - mkdocstrings:
      handlers:
        python:
          options:
            show_source: true
            show_root_heading: false
            heading_level: 4
  - mkdocs-simple-hooks:
      hooks:
        on_post_build: "docs.hooks:on_post_build"
nav:
  - Home: index.md
  - Getting started: getting-started.md
  - Content state: content-state.md
  - Markdown support: markdown.md
  - Markdown importer: markdown-importer.md
  - Migration guide: migration-guide.md
  - Agent skills: agent-skills.md
  - Guides:
      - Custom components: guides/custom-components.md
      - Fallback components: guides/fallback-components.md
      - Alternative engines: guides/alternative-engines.md
      - Custom engines: guides/custom-engines.md
  - Reference:
      - API: reference/api.md
      - Configuration: reference/configuration.md
      - Example output: reference/example.md
  - Troubleshooting: troubleshooting.md
  - Contributing:
      - Contributing: CONTRIBUTING.md
      - Project architecture: contributing/architecture.md
      - Test strategy: contributing/test-strategy.md
      - Skill and docs evals: contributing/evals.md
      - Research notes: contributing/research.md
      - Documentation style guide: style-guide.md
  - Security policy: SECURITY.md
  - Roadmap: ROADMAP.md
  - Support: SUPPORT.md