CI/CD

Mon, 01 Jan 0001 00:00:00 +0000

Prettier formatting

We use Prettier to format Docsy and the website files using the following command:

npm run check:format

To fix formatting, run Prettier: npm run fix:format.

i18n workaround

The translation files in the i18n directory are formatted using Prettier. But Prettier removes the blank line before the # Feedback section heading. This seems to be a known issue, for example see:

We’ve worked around this bug, and avoided using prettier-ignore directives, by formatting the preceding entry in the YAML file to be a block scalar, like this:

Git repo info and branch model

Mon, 01 Jan 0001 00:00:00 +0000

Monorepo

The main Docsy repository is effectively a monorepo containing the Docsy:

Theme at the repo root
Website in the docsy.dev directory. The website uses the Docsy theme, of course, with extra styling.

These two projects are kept in sync at release points, but they may diverge between releases, usually to allow the website to ship doc content and UX improvements without forcing a theme release.

The main Docsy example site is Goldydocs, located in the Docsy example site repository.

Build on Docsy

CI/CD

Prettier formatting

i18n workaround

Git repo info and branch model

Monorepo