strapi/docs/README.md

30 lines
705 B
Markdown
Raw Permalink Normal View History

2022-08-26 18:41:48 +02:00
# Strapi contributor documentation
2022-07-06 21:04:48 +02:00
2022-08-26 18:41:48 +02:00
> If you are looking for the official Strapi documentation, it is available [here](https://docs.strapi.io)
2022-07-06 21:04:48 +02:00
2022-08-26 18:41:48 +02:00
This documentation is a contributor documentation made for anyone that wants to contribute to the project.
To run the documentation website, follow the instructions below.
2022-07-06 21:04:48 +02:00
### Installation
```
$ yarn
```
### Local Development
```
$ yarn start
```
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
### Build
```
$ yarn build
```
This command generates static content into the `build` directory and can be served using any static contents hosting service.