Skip to content

Rearchitect documentation generator from markdown #1429

@Racer159

Description

@Racer159

Describe what should be investigated or refactored

We have had issues with Docusaurus and would like to explore other options for hosting a documentation site. This should explore:

  1. If we can modify Docusaurus to fit our needs better
  2. If another solution better meets our needs

This should not lose the following:

  1. Search - including good index and offline support
  2. Support for custom MDX syntax (notes and admonitions)
  3. Configurability/themability

This will also need an ADR comparing different options and explaining why we went a particular direction.

Links to any relevant code

https://github.com/defenseunicorns/zarf/tree/main/docs-website

Additional context

This comes out of us looking at our docs and thinking about how we could incorporate them into Zarf to bring it along to the airgap.

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions