gaspersic/solana
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
Files
v1.5.0
solana/docs
History
mergify[bot] 85fc51dc61 fix formatting error in docs (#14163) 
(cherry picked from commit 41a93ced23)

Co-authored-by: Jeff Washington (jwash) <wash678@gmail.com>
2020-12-16 18:51:24 +00:00
..
.travis
Move from gitbook to docusaurus, build docs in Travis CI (#10970)
2020-07-11 05:11:07 +00:00
art
…
src
fix formatting error in docs (#14163)
2020-12-16 18:51:24 +00:00
static
Retry inflation parameter update along with documentation updates (#12778)
2020-10-12 13:10:57 -07: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
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
2020-11-05 05:05:57 +00:00
build.sh
Report and bail on broken links (#13540)
2020-11-11 17:46:24 -08:00
convert-ascii-to-svg.sh
Change transparent .svg to opaque .png (#11084)
2020-07-15 21:35:18 +00:00
docusaurus.config.js
Report and bail on broken links (#13540)
2020-11-11 17:46:24 -08:00
offline-cmd-md-links.sh
…
package-lock.json
Report and bail on broken links (#13540)
2020-11-11 17:46:24 -08:00
package.json
Report and bail on broken links (#13540)
2020-11-11 17:46:24 -08:00
publish-docs.sh
fix doc redirects (#13709)
2020-11-19 21:34:21 +00:00
README.md
Clean up docs publishing flow (#11043)
2020-07-14 07:56:14 -06:00
set-solana-release-tag.sh
Guard against bsd sed (#13735)
2020-11-21 17:56:23 -08:00
sidebars.js
Add specific page for rpc endpoints (#13899)
2020-12-01 21:19:15 -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