Documentation

TIP

Before you start contributing, be sure to read the Contributing introduction.

The Codey Documentation is powered by VitePress and maintained within the codey repo.

To open the documentation locally, simply run:

npm run dev:docs

Update documentation

• Find the section / folder your topic fits under
• Make changes in the existing .md file
  • Mind the possibility that the markdown file could be copied by one of the scripts in /apps/documentation/scripts at build time.

New Documentation

Create file

Navigate to the folder where the new docs relate to and:

• Create a new .md file (using kebab-case)
• Add the new documentation

Add to navigation sidebar

All configuration regarding the sidebar can be found within the src/.vitepress/config.ts.

Creating Vue Components

Global components

Components for global use over the full documentation can be created in src/.vitepress/theme/components. They should follow the two word naming convention of components and will be usable with that name within the md files.

Documentation Specific Components

When certain documentation needs a non-global component it should be created as close as possible to where it will be used. Have a look at the style/assets structure for an example of this apps\documentation\src\docs\style\assets\components.