@nendlabs/docpage
v0.1.6
Published
an interactive paper-style project page renderer
Readme
@nendlabs/docpage repo
this repository contains the @nendlabs/docpage package, its playground, and internal docs.
repository overview
key paths:
src/: the package sourcestyles/: tailwind entry + theme tokensplayground/: local app to preview configsdocs/: deeper documentation and publishing notes.github/workflows/: ci and main-branch publishing
npm readme behavior
npm always reads README.md at publish time.
to keep this repo readme maintainer-focused while shipping a package-focused npm readme:
docs/package.mdis the source of truth for the npm readmeprepackcopiesdocs/package.mdintoREADME.mdpostpackrestores the originalREADME.md
relevant scripts:
bun run readme:packagebun run readme:restorebun run build
development
install and run the playground:
bun install
bun run devrun local validation:
bun run typecheck
bun run test
bun run builddocs
deeper documentation lives under docs/:
docs/authoring.mddocs/mdx.mddocs/publishing.mddocs/package.md
release flow
publishing is automated on pushes to main.
high level:
- open a pr into
main - bump
package.jsonversion in the pr - merge to
main - ci validates and the publish workflow runs
npm publish
see docs/publishing.md for details.
