solana/docs
Tyera Eulberg af9a3f004e
Fix typos (#13334)
2020-11-01 06:52:41 +00:00
..
.travis
art
src Fix typos (#13334) 2020-11-01 06:52:41 +00:00
static Retry inflation parameter update along with documentation updates (#12778) 2020-10-12 13:10:57 -07:00
.eslintrc
.gitignore
README.md
babel.config.js
build-cli-usage.sh
build.sh
convert-ascii-to-svg.sh
docusaurus.config.js Retry inflation parameter update along with documentation updates (#12778) 2020-10-12 13:10:57 -07:00
offline-cmd-md-links.sh
package-lock.json Retry inflation parameter update along with documentation updates (#12778) 2020-10-12 13:10:57 -07:00
package.json Retry inflation parameter update along with documentation updates (#12778) 2020-10-12 13:10:57 -07:00
publish-docs.sh
set-solana-release-tag.sh Use latest stable channel release if there's no beta release 2020-10-12 21:57:38 +00:00
sidebars.js Add design proposal and update validator-timestamp-oracle 2020-10-31 21:30:42 -07:00

README.md

Docs Readme

Solana's Docs are built using Docusaurus 2 with npm. Static content delivery is handled using vercel.

Installing Docusaurus

$ 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

Build Locally

This command generates static content into the build directory and can be served using any static contents hosting service.

$ 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.

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