solana/docs
Dan Albert 0ef3cac1f8
Update docs to show support for Nano X (#12647)
2020-10-02 16:45:24 -06:00
..
.travis
art
src Update docs to show support for Nano X (#12647) 2020-10-02 16:45:24 -06:00
static Remove developer mode step from Ledger Live setup 2020-10-02 15:21:38 -06:00
.eslintrc
.gitignore
README.md
babel.config.js
build-cli-usage.sh
build.sh
convert-ascii-to-svg.sh
docusaurus.config.js
offline-cmd-md-links.sh
package-lock.json
package.json
publish-docs.sh
set-solana-release-tag.sh Tighten docs publishing flow (#12572) 2020-09-30 11:24:00 -06:00
sidebars.js Add programming-faq to sidebar (#12586) 2020-09-30 09:56:48 +00: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