History

Trent Nelson 5354df8c1c Expand system tuning docs		2020-08-19 16:36:03 +00:00
..
.travis	…
art	…
src	Expand system tuning docs	2020-08-19 16:36:03 +00:00
static	fixes logo (#11350 )	2020-08-04 10:51:25 -07:00
.eslintrc	…
.gitignore	Add package-lock.json to docs (#11200 )	2020-07-24 14:15:22 -06:00
README.md	…
babel.config.js	…
build-cli-usage.sh	…
build.sh	…
convert-ascii-to-svg.sh	…
docusaurus.config.js	Comment that docs Algolia key is safe to publish	2020-08-18 05:25:51 +00:00
offline-cmd-md-links.sh	…
package-lock.json	Add package-lock.json to docs (#11200 )	2020-07-24 14:15:22 -06:00
package.json	…
publish-docs.sh	…
set-solana-release-tag.sh	…
sidebars.js	Restore CLI usage page (#11619 )	2020-08-13 16:02:13 -06:00

Docs Readme

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

$ npm install

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 generates static content into the build directory and can be served using any static contents hosting service.

$ docs/build.sh

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.