History

Evan B cb107edc97 Fix audit links for Stake Pool docs (#4187 ) Co-authored-by: Jon Cinque <joncinque@pm.me>		2023-05-05 22:31:48 +00:00
..
src	Fix audit links for Stake Pool docs (#4187 )	2023-05-05 22:31:48 +00:00
static	Update SPL logo (#2436 )	2021-09-21 13:35:44 -06:00
.gitignore	Implement docusaurus build, deployment and CI hooks (#129 )	2020-07-16 10:13:45 -06:00
README.md	adds program library logo and link back to docs (#191 )	2020-08-03 07:31:23 -07:00
babel.config.js	Implement docusaurus build, deployment and CI hooks (#129 )	2020-07-16 10:13:45 -06:00
build.sh	ci: Harden docs publish to only run with a vercel token (#3389 )	2022-07-27 16:57:59 +02:00
docusaurus.config.js	Update discord link in docs (#4079 )	2023-03-10 16:23:01 +00:00
package-lock.json	build(deps): bump minimatch, recursive-readdir and serve-handler in /docs (#3836 )	2023-05-03 11:48:15 +00:00
package.json	Update Token TS Docs (#2938 )	2022-02-22 13:47:11 -06:00
publish-docs.sh	docs: Remove dangling comma in JSON config (#4111 )	2023-04-03 21:47:29 +00:00
sidebars.js	docs: Add token-2022 one-pager (#4127 )	2023-04-18 00:07:16 +00:00
siteConfig.js	adds program library logo and link back to docs (#191 )	2020-08-03 07:31:23 -07:00

Docs Readme

SPL 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.

Documentation is published to spl.solana.com