solana-program-library/docs
mvines 331c0c20f6
Update discord link in docs (#4079)
2023-03-10 16:23:01 +00:00
..
src docs: Update ATA derivation example to use `findProgramAddressSync` (#4068) 2023-03-02 23:39:19 +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 @sideway/formula from 3.0.0 to 3.0.1 in /docs (#4044) 2023-02-14 13:02:51 +00:00
package.json Update Token TS Docs (#2938) 2022-02-22 13:47:11 -06:00
publish-docs.sh Implement docusaurus build, deployment and CI hooks (#129) 2020-07-16 10:13:45 -06:00
sidebars.js docs: documentation for account compression program (#3998) 2023-01-27 16:27:53 -06:00
siteConfig.js adds program library logo and link back to docs (#191) 2020-08-03 07:31:23 -07:00

README.md

Docs Readme

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

Documentation is published to spl.solana.com