Skip to content

UX-Wizards/wizards-wiki

Repository files navigation

UX Wizard Spellbook

Netlify Status

Formatting

We will be using Prettier to format document changes.

Code style guide

  1. root level index.md is where the wiki will open to.
  2. position property indexes start at 1.
  3. File names are in kebab-case. title property are sentence case versions of that file name.
  4. Put markdown files within their respective category directory.
  5. Category titles should be descriptive. Consider adding a new file to an existing category before creating a new one.
  6. WIP: Where to put images.

Setup

Install dependencies:

yarn install

Development

yarn dev

Static Generation

This will create the dist/ directory for publishing to static hosting:

yarn generate

To preview the static generated app, run yarn start

For detailed explanation on how things work, checkout nuxt/content and @nuxt/content theme docs.