nuartz is open source and welcomes contributions. Here's how to get started.
Setup
git clone https://github.com/syshin0116/nuartz.git
cd nuartz
bun installProject structure
nuartz/
apps/web/ # Next.js digital garden app
packages/nuartz/ # Core markdown processing library
See architecture for details on how the pieces fit together.
Development
Start the dev server:
bun devRun the full check (package build, generate, lint, typecheck, tests with coverage, and content validation), as CI does:
bun run checkMaking changes
- Create a branch from
main - Make your changes
- Add tests if you're modifying
packages/nuartz - Verify the dev server renders correctly
- Open a pull request
Content contributions
To add or improve documentation, edit files in apps/web/content/. Give each content file frontmatter with at least title and description; bun run check warns about a missing title. See Frontmatter for details.
Plugin contributions
If you're adding a new remark or rehype plugin, see creating-plugins for the conventions and testing patterns.