2020-07-10 22:11:07 -07:00
|
|
|
# Docs Readme
|
|
|
|
|
|
|
|
|
|
Solana's Docs are built using [Docusaurus 2](https://v2.docusaurus.io/) with `npm`.
|
|
|
|
|
Static content delivery is handled using `vercel`.
|
2018-12-13 09:25:25 -08:00
|
|
|
|
2020-07-14 06:56:14 -07:00
|
|
|
### Installing Docusaurus
|
2018-12-13 09:25:25 -08:00
|
|
|
|
2020-07-10 22:11:07 -07:00
|
|
|
```
|
|
|
|
|
$ npm install
|
2018-12-13 09:25:25 -08:00
|
|
|
```
|
|
|
|
|
|
2020-07-10 22:11:07 -07:00
|
|
|
### Local Development
|
2018-12-13 09:25:25 -08:00
|
|
|
|
2020-07-14 06:56:14 -07:00
|
|
|
This command starts a local development server and open up a browser window.
|
|
|
|
|
Most changes are reflected live without having to restart the server.
|
2021-01-25 15:36:11 -08:00
|
|
|
(You might have to run build.sh first if you run into failures)
|
2020-07-14 06:56:14 -07:00
|
|
|
|
2020-07-10 22:11:07 -07:00
|
|
|
```
|
|
|
|
|
$ npm run start
|
2018-12-13 09:25:25 -08:00
|
|
|
```
|
|
|
|
|
|
2020-07-14 06:56:14 -07:00
|
|
|
### Build Locally
|
2020-07-10 22:11:07 -07:00
|
|
|
|
|
|
|
|
This command generates static content into the `build` directory and can be
|
|
|
|
|
served using any static contents hosting service.
|
|
|
|
|
|
2020-07-14 06:56:14 -07:00
|
|
|
```
|
|
|
|
|
$ docs/build.sh
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### CI Build Flow
|
2020-07-10 22:11:07 -07:00
|
|
|
The docs are built and published in Travis CI with the `docs/build.sh` script.
|
|
|
|
|
On each PR, the docs are built, but not published.
|
|
|
|
|
|
|
|
|
|
In each post-commit build, docs are built and published using `vercel` to their
|
|
|
|
|
respective domain depending on the build branch.
|
|
|
|
|
|
|
|
|
|
- Master branch docs are published to `edge.docs.solana.com`
|
|
|
|
|
- Beta branch docs are published to `beta.docs.solana.com`
|
|
|
|
|
- Latest release tag docs are published to `docs.solana.com`
|
