The official documentation website for semantic-release, hosted at semantic-release.org.
Built with Astro and Starlight.
- Node.js (v18 or higher)
npm installnpm run devThis starts a local development server. The site will be available at http://localhost:4321.
npm run buildGenerates the production-ready static site in the dist/ directory.
npm run previewServes the built site locally for previewing before deployment.
npm run lint # Check formatting
npm run lint:fix # Fix formattingsrc/
├── assets/ # Images and static assets
├── components/ # Custom Astro components
├── content/docs/ # Documentation pages (Markdown/MDX)
│ ├── usage/ # Getting started, configuration, running semantic-release
│ ├── foundation/ # Concepts, constraints, and mental models of semantic-release
│ ├── extending/ # Plugin and shareable configuration lists
│ ├── recipes/ # CI configurations, git services, workflows
│ ├── support/ # FAQ, troubleshooting, version requirements
│ └── developer-guide/ # JS API, plugin development
└── styles/ # Global styles
Contributions are welcome! Please see the semantic-release contributing guidelines.
To contribute to the docs:
- Fork and clone this repository
- Create a new branch for your changes
- Run the site locally with
npm run dev - Make your edits in
src/content/docs/ - Submit a pull request
This project is part of the semantic-release organization.