https://github.com/semantic-release/docs
📘semantic-release official documentation and landing page
https://github.com/semantic-release/docs
Last synced: about 1 month ago
JSON representation
📘semantic-release official documentation and landing page
- Host: GitHub
- URL: https://github.com/semantic-release/docs
- Owner: semantic-release
- Created: 2026-01-13T15:28:10.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2026-06-19T10:58:56.000Z (about 1 month ago)
- Last Synced: 2026-06-19T12:28:51.670Z (about 1 month ago)
- Language: MDX
- Homepage: https://semantic-release.org
- Size: 2.03 MB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# semantic-release Documentation Site
The official documentation website for [semantic-release](https://github.com/semantic-release/semantic-release), hosted at [semantic-release.org](https://semantic-release.org/).
Built with [Astro](https://astro.build) and [Starlight](https://starlight.astro.build).
## Getting Started
### Prerequisites
- [Node.js](https://nodejs.org) (v18 or higher)
### Installation
```bash
npm install
```
### Development
```bash
npm run dev
```
This starts a local development server. The site will be available at `http://localhost:4321`.
### Build
```bash
npm run build
```
Generates the production-ready static site in the `dist/` directory.
### Preview
```bash
npm run preview
```
Serves the built site locally for previewing before deployment.
### Linting
```bash
npm run lint # Check formatting
npm run lint:fix # Fix formatting
```
## Project Structure
```
src/
├── 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
```
## Contributing
Contributions are welcome! Please see the [semantic-release contributing guidelines](https://github.com/semantic-release/semantic-release/blob/master/CONTRIBUTING.md).
To contribute to the docs:
1. Fork and clone this repository
2. Create a new branch for your changes
3. Run the site locally with `npm run dev`
4. Make your edits in `src/content/docs/`
5. Submit a pull request
## License
This project is part of the [semantic-release](https://github.com/semantic-release) organization.