Codey

Appearance

Documentation ​

TIP

Before you start, be sure to read the Introduction.

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

To open the documentation locally, simply run:

sh
npm run dev:docs

INFO

At the time of writing, VuePress 2 is still in Beta. More information on the decision regarding this version can be found in the following ADL Record

Update documentation ​

  • Find the section / folder your topic fits under
  • Make changes in the existing .md file

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/.vuepress/config.ts.

The configuration for the following sections is automatically generated based on the files within the folders:

- docs/
  - style
  - components
  - starters
- cookbook
- packages/
  - The sub files of every item are automatically mapped, only a new packages needs to be configured.
- releases

Within these structures no updates to the config are required.

Creating Vue Components ​

Global components ​

Components for global use over the full documentation can be created in src/.vuepress/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 need a 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 here apps\documentation\src\docs\style\assets\components.