Skip to content
silarhiPublic

About

Shared Starlight kit for the documentation of SILARHI open-source packages

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

SILARHI documentation theme

Monorepo of the documentation tooling of the SILARHI open-source packages.

Path What
packages/docs-kit @silarhi/docs-kit on npm
site The hub, docs.silarhi.dev: the package list and the theme guide

Each package documents itself from its own docs/ folder, published at https://<package>.silarhi.dev by the reusable workflow docs-site.yml of this repository.

Development

pnpm install
pnpm dev     # the hub, with the local theme
pnpm lint

A pnpm workspace (pnpm-workspace.yaml): the hub depends on the theme through workspace:*. The pnpm version is pinned by packageManager in package.json; a dependency that needs an install script must be listed under allowBuilds in pnpm-workspace.yaml (none does today).

To try the theme on a package before releasing it: pnpm link <path to>/docs-kit/packages/docs-kit in the docs/ folder of the package.

Release

  1. Bump version in packages/docs-kit/package.json
  2. Tag v<version> on origin/main and push the tag: release.yml publishes to npm

License

MIT

About

Shared Starlight kit for the documentation of SILARHI open-source packages

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages