project-serum
/
solana
mirror of https://github.com/project-serum/solana.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
solana/docs
History
mergify[bot] 78c4f946f4
Terminology fixes (#14112) (#14114) 
(cherry picked from commit 42be09afb66c405b42ab66c3f1724b94614d79a1)

Co-authored-by: Jeff Washington (jwash) <75863576+jeffwashington@users.noreply.github.com>
 		2020-12-14 21:15:12 +00:00
..
.travis Move from gitbook to docusaurus, build docs in Travis CI (#10970) 2020-07-11 05:11:07 +00:00
art Cleanup programming model doc (#10274) 2020-05-27 16:18:11 -06:00
src Terminology fixes (#14112) (#14114) 2020-12-14 21:15:12 +00:00
static Remove developer mode step from Ledger Live setup 2020-10-02 15:21:38 -06:00
.eslintrc Move from gitbook to docusaurus, build docs in Travis CI (#10970) 2020-07-11 05:11:07 +00:00
.gitignore Add package-lock.json to docs (#11200) 2020-07-24 14:15:22 -06:00
README.md Clean up docs publishing flow (#11043) 2020-07-14 07:56:14 -06:00
babel.config.js Move from gitbook to docusaurus, build docs in Travis CI (#10970) 2020-07-11 05:11:07 +00:00
build-cli-usage.sh CI: Use branch-versioned cargo throughout (#13411) 2020-11-05 06:25:11 +00:00
build.sh Update build.sh 2020-07-18 08:31:54 -06:00
convert-ascii-to-svg.sh Change transparent .svg to opaque .png (#11084) 2020-07-15 21:35:18 +00:00
docusaurus.config.js Update development docs (#13661) 2020-11-18 09:27:11 +00:00
offline-cmd-md-links.sh Docs: Update CLI offline cmds (#8548) 2020-03-01 17:20:37 -07:00
package-lock.json Update development docs (#13661) 2020-11-18 09:27:11 +00:00
package.json Update development docs (#13661) 2020-11-18 09:27:11 +00:00
publish-docs.sh fix doc redirects (#13709) (#13710) 2020-11-19 21:41:23 +00:00
set-solana-release-tag.sh Guard against bsd sed (#13735) (#13751) 2020-11-22 02:03:23 +00:00
sidebars.js Add specific page for rpc endpoints (#13899) (#13910) 2020-12-02 04:25:58 +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