Files

mergify[bot] 24bae00560 docs: Add docs for solana-test-validator (backport #17199 ) (#17211 )

* docs: Add docs for `solana-test-validator`

(cherry picked from commit 768a2ebe9d)

* Update docs/src/developing/test-validator.md

Co-authored-by: Tyera Eulberg <teulberg@gmail.com>
(cherry picked from commit 056c1a7b50)

* Update docs/src/developing/test-validator.md

Co-authored-by: Tyera Eulberg <teulberg@gmail.com>
(cherry picked from commit 5b13d4057b)

* Update docs/src/developing/test-validator.md

Co-authored-by: Tyera Eulberg <teulberg@gmail.com>
(cherry picked from commit 38d7e9a4c4)

* Update docs/src/developing/test-validator.md

Co-authored-by: Tyera Eulberg <teulberg@gmail.com>
(cherry picked from commit e08687acfd)

* Update docs/src/developing/test-validator.md

Co-authored-by: Tyera Eulberg <teulberg@gmail.com>
(cherry picked from commit 3214105a21)

* Update docs/src/developing/test-validator.md

(cherry picked from commit 7868df3211)

* Update docs/src/developing/test-validator.md

(cherry picked from commit 3e0c0abb53)

Co-authored-by: Trent Nelson <trent@solana.com>

2021-05-13 18:41:16 +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

i18n/zh

Add chinese translations to docs (#17125 ) (#17127 )

2021-05-08 17:09:51 +00:00

src

docs: Add docs for solana-test-validator (backport #17199 ) (#17211 )

2021-05-13 18:41:16 +00:00

static

Reorg and cleanup of economics section of docs (#14868 )

2021-01-27 22:54:00 +01:00

.eslintignore

Docs cleanup (#16997 )

2021-05-03 02:59:03 +00:00

.eslintrc

Move from gitbook to docusaurus, build docs in Travis CI (#10970 )

2020-07-11 05:11:07 +00:00

.gitignore

Fix cli usage build

2021-01-29 19:03:10 +00:00

.prettierignore

Docs cleanup (#16997 )

2021-05-03 02:59:03 +00: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

Fix cli usage build

2021-01-29 19:03:10 +00:00

build.sh

Only publish release-tag docs on beta channel (#15158 )

2021-02-05 23:39:04 -07:00

convert-ascii-to-svg.sh

Change transparent .svg to opaque .png (#11084 )

2020-07-15 21:35:18 +00:00

docusaurus.config.js

Add chinese translations to docs (#17125 ) (#17127 )

2021-05-08 17:09:51 +00:00

offline-cmd-md-links.sh

Docs: Update CLI offline cmds (#8548 )

2020-03-01 17:20:37 -07:00

package-lock.json

Docs cleanup (#16997 )

2021-05-03 02:59:03 +00:00

package.json

Docs cleanup (#16997 )

2021-05-03 02:59:03 +00:00

publish-docs.sh

docs: rename 'deployed programs' section to 'on-chain programs'

2021-03-11 08:38:18 +00:00

README.md

Docs cleanup (#16997 )

2021-05-03 02:59:03 +00:00

set-solana-release-tag.sh

Guard against bsd sed (#13735 )

2020-11-21 17:56:23 -08:00

sidebars.js

docs: Add docs for solana-test-validator (backport #17199 ) (#17211 )

2021-05-13 18:41:16 +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. (You might have to run build.sh first if you run into failures)

$ 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