Clean up docs publishing flow (#11043)

* Clean up publishing flow

* Update README

Co-authored-by: publish-docs.sh <maintainers@solana.com>
This commit is contained in:
Dan Albert
2020-07-14 07:56:14 -06:00
committed by GitHub
parent 14ac233d01
commit 303a4df6ef
7 changed files with 53 additions and 52 deletions

View File

@ -3,7 +3,7 @@
Solana's Docs are built using [Docusaurus 2](https://v2.docusaurus.io/) with `npm`.
Static content delivery is handled using `vercel`.
### Installation
### Installing Docusaurus
```
$ npm install
@ -11,22 +11,23 @@ $ npm install
### Local Development
This command starts a local development server and open up a browser window.
Most changes are reflected live without having to restart the server.
```
$ npm run start
```
This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.
### Build
#### Local Build Testing
```
$ npm run build
```
### Build Locally
This command generates static content into the `build` directory and can be
served using any static contents hosting service.
#### CI Build Flow
```
$ docs/build.sh
```
### CI Build Flow
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.