Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
253 commits
Select commit Hold shift + click to select a range
c9d9445
Add token docs (#158)
jackcmay Jul 28, 2020
e1c49ba
Add memo docs (#160)
jackcmay Jul 28, 2020
3e0dee0
Add prelim token-swap docs (#161)
jackcmay Jul 28, 2020
735571a
adds program library logo and link back to docs (#191)
rajgokal Aug 3, 2020
b5a6fb1
Correct github link
mvines Aug 4, 2020
98bfaf4
Add spl-token documentation
mvines Aug 10, 2020
2597d13
Add transfer example
mvines Aug 10, 2020
1102e51
Adapt spl-token cli to Solana 1.3.2
mvines Aug 11, 2020
e02db3b
Token nits (#353)
garious Aug 28, 2020
319e4db
Update token js bindings
jstarry Aug 28, 2020
1f64bc0
Update token docs (#360)
jackcmay Aug 29, 2020
ec11643
Fix up spl-token docs (#379)
CriesofCarrots Sep 2, 2020
f36050d
Bump Token version to 2.0.4
t-nelson Sep 4, 2020
87d1552
Update logos (#389)
rmshea Sep 8, 2020
8b93860
Javascript -> JavaScript (#409)
garious Sep 9, 2020
87d97b8
Clarify token freeze authority documentation (#456)
jackcmay Sep 16, 2020
deda5bc
Docs: Describe how to configure spl-token-cli
t-nelson Sep 18, 2020
a80c6b6
Fix multisign check (#479)
jackcmay Sep 18, 2020
0dc1193
backport #479 to v2
jackcmay Sep 21, 2020
506d688
Add doc info about generating keypair (#516)
jackcmay Sep 22, 2020
d68176e
Add NTF documentation
mvines Oct 14, 2020
86dc830
add shared-memory program (#611)
jackcmay Oct 14, 2020
25134da
Add JSON RPC methods section
mvines Oct 15, 2020
8904a16
Document self-transfer behavior (#743)
jstarry Oct 28, 2020
102dc18
Document about the known fake rent issue (#753)
ryoqun Oct 30, 2020
d3735ad
Add Search functionality (#729)
rmshea Oct 30, 2020
ccd3ccd
Add SPL Token wallet integration guide
mvines Oct 15, 2020
57f3b15
Add associated-token-account documentation
mvines Nov 4, 2020
494c657
Update doc links
mvines Nov 5, 2020
2132540
Fix broken stake-pool docs link and make readme's consistent (#805)
jstarry Nov 6, 2020
5c61520
ed
mvines Nov 6, 2020
03df3c8
Docs: Add Token multisig examples
t-nelson Nov 10, 2020
4032983
Apply suggestions from code review
t-nelson Nov 10, 2020
7dd0252
Apply suggestions from code review
t-nelson Nov 10, 2020
39ea670
Apply suggestions from code review
t-nelson Nov 10, 2020
8e8becd
Correct `findAssociatedTokenAddress` JS sample
mvines Nov 18, 2020
6c9c971
Fix findAssociatedTokenAddress more
mvines Nov 18, 2020
12d4c64
K
mvines Nov 18, 2020
68366c1
Initial feature proposal documentation
mvines Nov 18, 2020
58a5dde
Update docs/src/feature-proposal.md
mvines Nov 18, 2020
ebeb76d
Rename 'delivery' to 'distributor'
mvines Nov 18, 2020
1d24760
t
mvines Nov 18, 2020
a81fe47
[AToken] add motivation section to docs (#870)
paul-schaaf Nov 19, 2020
11a1dd9
Introduce SPL Token Lending (#696)
jstarry Dec 19, 2020
dddcb48
Refine SPL Token wallet integration guide
mvines Jan 12, 2021
4b65efc
Fix doc typos (#1137)
CriesofCarrots Jan 27, 2021
3508716
Add initial signed-memo program (#1135)
CriesofCarrots Jan 28, 2021
87004ee
docs: Flesh out token swap README (#1133)
joncinque Feb 5, 2021
37619ad
fix typos
WhoSoup Feb 17, 2021
70270df
Remove outdated comment (#1373)
ryoqun Mar 4, 2021
0bde298
token-swap: Document owner address in README (#1368)
joncinque Mar 4, 2021
0523b0e
lending: Add program addresses to docs (#1442)
jstarry Mar 12, 2021
a366c61
stake-pool: Add usage docs (#1277)
joncinque Mar 15, 2021
9cc6b6c
Update accounts examples (#1478)
CriesofCarrots Mar 22, 2021
c1edc86
Move to positional parameters
mvines Mar 30, 2021
64f6989
stake-pool: Rename instructions / structs (#1536)
joncinque Mar 30, 2021
f347ba6
stake-pool: Assess fee as a percentage of rewards (#1597)
joncinque Apr 15, 2021
3e073e5
docs: specify mint in `spl-token transfer` examples
t-nelson Apr 16, 2021
ce89436
stake-pool: Set fee (#1604)
joncinque Apr 21, 2021
16d1ab9
docs: specify mint in spl-token balance examples (#1634)
CriesofCarrots Apr 26, 2021
17572d0
Add airdrop help to token docs (#1636)
CriesofCarrots Apr 26, 2021
62d0c05
Add name-service program and js bindings (#1600)
Lcchy May 4, 2021
778a841
Add name service to sidebar
mvines May 4, 2021
012f406
stake-pool: Update docs for all new features (#1651)
joncinque May 5, 2021
db547af
Explicitly call out the --decimals argument to `spl-token create-token`
mvines May 5, 2021
3020fa6
Update token.md
mvines May 6, 2021
a6f4e05
Account with 2 Cs (#1680)
CriesofCarrots May 8, 2021
fb1444b
adjust typos and proper nouns on naming service page
drbh May 9, 2021
521455c
incorrect capitalization
drbh May 9, 2021
64ee3b9
docs: add token vesting section
May 8, 2021
ee5376a
swap associated token account addr for token addr (#1705)
drbh May 11, 2021
8e41572
fix a 404 link
max-block May 29, 2021
aa4842f
Comment says javascript but code is typescript (#1744)
Henry-E Jun 3, 2021
b962e73
token-docs: add token registry (#1855)
joncinque Jun 3, 2021
c4d3f37
Update api urls in docs (#1887)
CriesofCarrots Jun 8, 2021
d360eb7
Fixup spl-token create-account example (#1897)
CriesofCarrots Jun 10, 2021
dfec406
Also clone program data (#1904)
jon-chuang Jun 15, 2021
8961740
stake-pool: Wait to apply new fee (#1922)
joncinque Jun 15, 2021
62163ab
Fix a variety of token.md doc inconsistencies; improve multi-sign non…
JohnDoe389 Jul 1, 2021
5de80b7
spl-token docs: Create NFT token with 0 decimal place
HaoCherHong Jul 8, 2021
c73441b
update token.md (#2075)
chaseeb Jul 13, 2021
b590866
stake-pool: Update docs with new instructions and output (#2125)
joncinque Jul 25, 2021
143e5ca
stake-pool docs: Clarify withdrawal (#2146)
joncinque Jul 29, 2021
cf1ff8c
(docs) Fix broken links (#2424)
Konosh93 Sep 16, 2021
71d8f9b
Update SPL logo (#2436)
rmshea Sep 21, 2021
28d45e0
stake-pool: Update docs and help messages (#2435)
joncinque Sep 23, 2021
9498da4
stake-pool: Add withdraw-sol command + CLI + docs (#2475)
joncinque Oct 6, 2021
77fbf6e
stake-pool: Clarify stake deposit fee (#2520)
joncinque Oct 19, 2021
4a364ac
stake-pool-cli: Improve deposit and withdraw UX (#2530)
joncinque Oct 19, 2021
7503ee5
stake-pool-cli: Add more docs around scripts (#2531)
joncinque Oct 19, 2021
33c5ba9
stake-pool-cli: Add validator list argument to create (#2545)
joncinque Oct 25, 2021
027e589
stake-pool-docs: Add the published audits (#2546)
joncinque Oct 26, 2021
33912d6
stake-pool: Reduce wait for active stake merges (#2553)
joncinque Nov 1, 2021
8b15322
stake-pool-docs: Rearrange docs, add quickstart guide (#2561)
joncinque Nov 6, 2021
5a2df81
docs: Prefer non gendered pronouns (#2610)
brooksprumo Dec 2, 2021
330c2ea
docs: token: Added timelock program (#2616)
imprfekt Dec 4, 2021
b245460
stake-pool-docs: Clarify that epoch fee is on top of commissions (#2652)
joncinque Dec 20, 2021
d141748
stake-pool: Reduce maximum pool size (#2654)
joncinque Dec 21, 2021
aa231e4
fix: token address in place of sender address
emhane Dec 27, 2021
ffa15e0
Decrease the stake pool size due to the new mem op syscall base cost …
dmakarov Jan 5, 2022
53f7b99
Update stake-pool.md (#2702)
noopurphalak Jan 6, 2022
80d3cb1
stake-pool-cli: Add best practices for fees, prevent zero fees (#2670)
joncinque Jan 11, 2022
9b0e355
docs: token: Added missing information about security audit (#2724)
imprfekt Jan 11, 2022
d8eb36c
fix small typo (#2727)
biw Jan 11, 2022
66c8b95
Added token ts docs (#2575)
jacobcreech Feb 19, 2022
45858b0
Revert "Added token ts docs (#2575)" (#2933)
jacobcreech Feb 19, 2022
1c0feb9
Update Token TS Docs (#2938)
jacobcreech Feb 22, 2022
687d3d5
empty commit; rebuild docs
jordaaash Feb 22, 2022
9a6d1bb
Update token.mdx (#3049)
Anurag5086 Mar 29, 2022
c736719
Confusion with decimals (#3187)
S1nus May 20, 2022
8afa873
docs: add missing single quote (#3200)
katopz May 31, 2022
b24b997
token-swap: Prepare v3.0.0 release for testnet and devnet (#3227)
joncinque Jun 7, 2022
3f72e2d
Used full out spelling to resolve confusion - related to #3330 (#3331)
fskroes Jul 11, 2022
194b8f5
Update associated-token-account.md (#3329)
evilboyajay Jul 19, 2022
b7c6786
token-2022: Add intro docs, structure for more docs (#3384)
joncinque Jul 27, 2022
179249f
docs: Fix links (#3387)
joncinque Jul 27, 2022
68491ec
ci: Fixup docs CI to run build on all affecting PRs (#3388)
joncinque Jul 27, 2022
74e1d58
ci: Harden docs publish to only run with a vercel token (#3389)
joncinque Jul 27, 2022
06d0061
Confidential transfer overview doc (#3393)
samkim-crypto Jul 28, 2022
ccaca51
docs: Fix link in token-2022 (#3394)
joncinque Jul 29, 2022
9811635
Confidential transfer encryption doc (#3399)
samkim-crypto Aug 2, 2022
bd73cba
Add doc file
joncinque Jul 24, 2022
26db443
Address feedback
joncinque Aug 5, 2022
c711d02
Rename e to tokenAccount / error as appropriate
mikemaccana Aug 8, 2022
07835b3
Confidential transfer zk doc (#3437)
samkim-crypto Aug 11, 2022
ffd56f1
Add docs for migrating a program to two token programs
joncinque Aug 10, 2022
3e43b0a
docs: Add token-2022 extension docs and JS examples (#3457)
joncinque Aug 15, 2022
cc0538d
fix typo (#3559)
samkim-crypto Sep 1, 2022
0acf784
Add documentation
joncinque Aug 17, 2022
7339dc9
docs: Use new overload of confirm tx in token-2022 extension examples…
thesoftwarejedi Sep 6, 2022
dc859c0
Add docs
joncinque Aug 24, 2022
8108816
Update token-2022.md (#3576)
jnwng Sep 8, 2022
571ccd1
token-upgrade: Add CLI and docs (#3593)
joncinque Sep 15, 2022
f9973a7
Fixed typo (#3643)
IDrawCharts Sep 25, 2022
c5a667c
stake-pool: Add / remove validators from the reserve (#3714)
joncinque Nov 21, 2022
5840377
[docs] Add formal spec for the public-key validity proof (#3863)
samkim-crypto Dec 2, 2022
a19d956
docs: Add token-2022 audits and clarify upgradability (#3894)
joncinque Dec 13, 2022
2ddf22c
docs: Add stake pool fees page to the sidebar (#3911)
joncinque Dec 14, 2022
c8a25a8
docs: Add token-2022 extension usage examples in CLI (#3919)
joncinque Dec 16, 2022
fb16b68
docs: Add second stake pool audit by Neodyme (#3945)
joncinque Dec 23, 2022
ec4f071
build(deps): bump json5 and babel-loader in /docs (#3951)
dependabot[bot] Jan 2, 2023
5d9fa47
stake-pool: Wait at least two epoch boundaries to set fee (#3979)
joncinque Jan 27, 2023
5c1266e
docs: documentation for account compression program (#3998)
anoushk1234 Jan 27, 2023
273b3ff
Fix: typos (#4019)
omahs Feb 2, 2023
68272c4
docs: Clarify audit status of all programs, no S word (#4046)
joncinque Feb 13, 2023
a9fd2b0
build(deps): bump @sideway/formula from 3.0.0 to 3.0.1 in /docs (#4044)
dependabot[bot] Feb 14, 2023
c82ab6b
fix typo in confidential token docs (#4065)
gr8den Feb 27, 2023
934d618
docs: Update ATA derivation example to use `findProgramAddressSync` (…
quellen-sol Mar 2, 2023
8ac9fc4
Update discord link in docs (#4079)
mvines Mar 10, 2023
0a02d30
remove extra `can use` on account-compression docs (#4085)
trankhacvy Mar 13, 2023
e7c3f4c
docs: Update token-2022 audits (#4109)
joncinque Apr 3, 2023
949a714
docs: Add scope from secrets (#4110)
joncinque Apr 3, 2023
01c0c5b
docs: Remove dangling comma in JSON config (#4111)
joncinque Apr 3, 2023
2802b8d
typo fix (#4112)
Altar12 Apr 6, 2023
d63b5f0
Update concepts.md to fix type (#4120)
joey-02 Apr 14, 2023
9d29456
docs: Add token-2022 one-pager (#4127)
joncinque Apr 18, 2023
cff14b8
build(deps): bump minimist from 1.2.5 to 1.2.8 in /docs (#4049)
dependabot[bot] Apr 18, 2023
df8f5e6
build(deps): bump http-cache-semantics from 4.1.0 to 4.1.1 in /docs (…
dependabot[bot] Apr 18, 2023
5b02e16
docs: Add permanent delegate extension and example (#4134)
joncinque Apr 24, 2023
eb6c1b6
build(deps): bump async from 2.6.3 to 2.6.4 in /docs (#3100)
dependabot[bot] May 3, 2023
b89c31b
build(deps): bump ua-parser-js from 0.7.31 to 0.7.35 in /docs (#4154)
dependabot[bot] May 3, 2023
a29c859
build(deps): bump terser from 5.11.0 to 5.17.1 in /docs (#4155)
dependabot[bot] May 3, 2023
a3cfd5c
build(deps): bump node-forge from 1.2.1 to 1.3.1 in /docs (#3158)
dependabot[bot] May 3, 2023
8ea20b0
build(deps): bump minimatch, recursive-readdir and serve-handler in /…
dependabot[bot] May 3, 2023
e1a8ade
Fix audit links for Stake Pool docs (#4187)
ebatsell May 5, 2023
c50f637
token-2022: Integrate transfer-hook interface in program (#4151)
joncinque May 11, 2023
8f0dbf3
build(deps): bump nth-check and @slorber/static-site-generator-webpac…
dependabot[bot] May 15, 2023
9af1e85
docs: Scrub all references to token-list (#4229)
joncinque May 18, 2023
685e65f
docs: Add basic token-2022 wallet guide (#4325)
joncinque May 31, 2023
25563f7
docs: Be really clear that token-2022 is still under audit (#4435)
joncinque Jun 1, 2023
6a234d9
docs: Delay token-2022 status dates by one month as we finish (#4433)
joncinque Jun 1, 2023
2cffabe
Fix grammar issue in the Non-Transferable Tokens section in extension…
owenventer Jun 5, 2023
37aff36
docs: Add create ATA instruction to token-2022 wallet guide (#4434)
joncinque Jun 6, 2023
913a44d
build(deps): bump semver, @docusaurus/core, @docusaurus/preset-classi…
dependabot[bot] Jun 26, 2023
f543b03
Revert "build(deps): bump semver, @docusaurus/core, @docusaurus/prese…
joncinque Jun 26, 2023
49dbca1
docs: Update node version and docusaurus (#4617)
joncinque Jun 27, 2023
3526733
token-2022: Make `Extension::get_account_len` fallible (#4646)
joncinque Jun 29, 2023
5076668
docs: Add token-2022 presentation as markdown (#4634)
joncinque Jul 6, 2023
043f67f
token-2022: Add account-level alloc and realloc (#4661)
joncinque Jul 10, 2023
c07acd1
build(deps): bump semver from 5.7.1 to 5.7.2 in /docs (#4755)
dependabot[bot] Jul 11, 2023
6ee0747
build(deps): bump word-wrap from 1.2.3 to 1.2.4 in /docs (#4822)
dependabot[bot] Jul 19, 2023
d86a331
[docs] Update token-2022 project status on proof split (#4843)
samkim-crypto Jul 25, 2023
5d4a255
rename PodAccountMeta to ExtraAccountMeta (#4984)
Aug 10, 2023
40f4e51
add single pool to spl.solana.com
2501babe Aug 14, 2023
81b2f98
docs: Clarify stake pool fees more (#5032)
joncinque Aug 15, 2023
d09a56e
fix: typos (#5030)
omahs Aug 15, 2023
e2fbe18
Transfer Hook Docs (#5034)
Aug 16, 2023
02f891a
docs: Specify that the stake pool staker can update the staker (#5043)
joncinque Aug 17, 2023
750c694
token-js: Added support for transfer hook instructions (#5096)
wjthieme Aug 24, 2023
fbb937a
docs: Explain the token-2022 metadata and pointer extensions (#5095)
joncinque Aug 25, 2023
fc70404
build(deps): bump postcss from 8.4.24 to 8.4.31 in /docs (#5425)
dependabot[bot] Oct 3, 2023
5c41b3e
build(deps): bump @babel/traverse from 7.22.5 to 7.23.2 in /docs (#5557)
dependabot[bot] Oct 16, 2023
a6c38d9
transfer-hook: Move interface and example into subfolders (#5640)
joncinque Oct 24, 2023
b48d62c
docs: Update token-2022 extensions (#5788)
joncinque Nov 9, 2023
343b9a8
docs: Add quickstart guide for confidential tokens (#5786)
joncinque Nov 9, 2023
e7a739e
single-pool: update docs with examples (#5414)
2501babe Nov 9, 2023
c09632f
docs: Fix typos (#5808)
omahs Nov 13, 2023
7e4e7fd
docs: Add status of the token program (#5883)
joncinque Nov 22, 2023
f205bb8
build(deps): bump trim, @docusaurus/core and @docusaurus/preset-class…
dependabot[bot] Nov 22, 2023
177b05c
[docs]: add edit page button to GitHub PRs (#5916)
Nov 28, 2023
a8a57d3
stake-pool: Update security and audit info (#5945)
joncinque Dec 4, 2023
f808ba1
Documentation Tweaks (#5967)
joaolago1113 Dec 8, 2023
c898a68
Fix typos (#5973)
nnsW3 Dec 11, 2023
c477b7c
token-2022: Update audit and release info (#5995)
joncinque Dec 13, 2023
8fdf2e1
docs: Add CPI Guard extension info (#5876)
joncinque Dec 13, 2023
9d7e42c
Documentation Enhancements for Clarity and Accuracy in Solana Project…
joaolago1113 Dec 17, 2023
69f8fa2
Remove sollet reference from token docs (#6032)
Dec 26, 2023
6bd2cb0
[docs] Add link to OtterSec zk-token-sdk audit (#6052)
samkim-crypto Jan 3, 2024
b15a830
docs: add token group docs (#6017)
Jan 5, 2024
c367bff
Fix typo in extensions.mdx (#6086)
jnwng Jan 8, 2024
af676bb
docs: Specify that token-2022 is ready and eligible for bounties (#6084)
joncinque Jan 9, 2024
d74e594
build(deps): bump follow-redirects from 1.15.3 to 1.15.4 in /docs (#6…
dependabot[bot] Jan 9, 2024
4d73504
chore(docs): proofreading the docs (#6129)
guerrierindien Jan 13, 2024
849b520
single-pool: add third audit (#6145)
2501babe Jan 18, 2024
b2b205b
audit: Add latest stake pool audit from Halborn (#6174)
joncinque Jan 24, 2024
2607cca
docs: transfer hook interface (#6176)
Jan 26, 2024
3cc6207
docs: Add "Token Extensions" in the top-level doc (#6183)
joncinque Jan 26, 2024
f36b6b8
Doc(extensions.mdx): correct import statment (#6301)
MohammedAlabd Feb 26, 2024
6772e35
fix some comments (#6318)
cuishuang Mar 3, 2024
d4009e7
fix GitHub capitalization: change 'github' to 'GitHub' (#6348)
jarrensj Mar 7, 2024
0828a4c
correct capitalization: change 'token-2022' to 'Token-2022' (#6374)
jarrensj Mar 11, 2024
c8788d4
fix punctuation in the Account Compression Program doc (#6375)
jarrensj Mar 11, 2024
683ea3e
Extensions doc metadata js example (#6396)
MohammedAlabd Mar 12, 2024
ec39b3c
build(deps): bump follow-redirects from 1.15.4 to 1.15.6 in /docs (#6…
dependabot[bot] Mar 18, 2024
6bb25d8
build(deps): bump webpack-dev-middleware from 5.3.3 to 5.3.4 in /docs…
dependabot[bot] Mar 22, 2024
8772c71
chore: fix some typos (#6483)
deterclosed Mar 23, 2024
b98dfff
build(deps): bump express from 4.18.2 to 4.19.2 in /docs (#6491)
dependabot[bot] Mar 26, 2024
e7cbd21
docs: Add confidential transfer test script (#6561)
joncinque Apr 9, 2024
7d045f9
token-2022: Add memo-transfer examples (#6668)
joncinque May 7, 2024
42dbf36
build(deps): bump braces from 3.0.2 to 3.0.3 in /docs (#6835)
dependabot[bot] Jun 11, 2024
18bfb84
fix: broken link for on-chain transfer hook example (#7041)
jim4067 Jul 22, 2024
b35e480
chore: fix some comments (#7054)
riyueguang Jul 26, 2024
4e28dd9
build(deps): bump axios from 1.6.2 to 1.7.4 in /docs (#7151)
dependabot[bot] Aug 14, 2024
9a9ddef
build(deps): bump micromatch from 4.0.5 to 4.0.8 in /docs (#7195)
dependabot[bot] Aug 26, 2024
cb6c5a4
build(deps): bump webpack from 5.89.0 to 5.94.0 in /docs (#7204)
dependabot[bot] Aug 27, 2024
19115fb
docs: Update stake pool devnet info (#7221)
joncinque Aug 30, 2024
dcdcb04
docs: Update the status of token-2022 (#7222)
joncinque Aug 30, 2024
cda463c
build(deps): bump body-parser and express in /docs (#7263)
dependabot[bot] Sep 12, 2024
2ab41c8
Fix Transfer amount for 1 token in token-2022.md (#7271)
Sep 13, 2024
99fe2dc
Update a typo in presentation.md (#7284)
AbhisekBasu1 Sep 23, 2024
d5ffd2c
docs: Specify behavior for dupes in token multisig (#7386)
joncinque Oct 22, 2024
f614923
build(deps): bump http-proxy-middleware from 2.0.6 to 2.0.7 in /docs …
dependabot[bot] Oct 23, 2024
8301527
Lock to web3.js 1.x for compatibility (#7419)
steveluscher Nov 1, 2024
a6fdace
Update URLs to point specifically to v1 of the `@solana/web3.js` docs
steveluscher Nov 7, 2024
00ae15b
build(deps): bump cookie and express in /docs (#7477)
dependabot[bot] Nov 8, 2024
ed28960
build(deps): bump cross-spawn from 7.0.3 to 7.0.5 in /docs (#7498)
dependabot[bot] Nov 18, 2024
fc7892f
memo: Remove local program / client and point to new repo (#7535)
joncinque Dec 2, 2024
958289e
Update transfer-fee parameters to new version (#7561)
Woody4618 Dec 5, 2024
34c8287
build(deps): bump nanoid from 3.3.6 to 3.3.8 in /docs (#7572)
dependabot[bot] Dec 10, 2024
033fd17
docs: Point everything at the new repos
joncinque Jan 10, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions docs/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Dependencies
/node_modules

# Production
/build

# Generated files
.docusaurus
.cache-loader
.vercel
vercel.json

# Misc
.DS_Store
.env.local
.env.development.local
.env.test.local
.env.production.local

npm-debug.log*
yarn-debug.log*
yarn-error.log*
37 changes: 37 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# Docs Readme

SPL Docs are built using [Docusaurus 2](https://v2.docusaurus.io/) with `npm`.
Static content delivery is handled using `vercel`.

### Installing Docusaurus

```
$ npm install
```

### Local Development

This command starts a local development server and opens 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
3 changes: 3 additions & 0 deletions docs/babel.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
module.exports = {
presets: [require.resolve("@docusaurus/core/lib/babel/preset")],
};
27 changes: 27 additions & 0 deletions docs/build.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
#!/usr/bin/env bash
set -ex

cd "$(dirname "$0")"

# shellcheck source=ci/env.sh
source ../ci/env.sh

# Publish only if in CI, vercel token is present, and it's not a pull request
if [[ -n $CI ]] && [[ -n $VERCEL_TOKEN ]] && [[ -z $CI_PULL_REQUEST ]]; then
PUBLISH_DOCS=true
else
PUBLISH_DOCS=
fi

if [[ -n $PUBLISH_DOCS ]]; then
npm install --global docusaurus-init
docusaurus-init
npm install --global vercel
fi

# Build from /src into /build
npm run build

if [[ -n $PUBLISH_DOCS ]]; then
./publish-docs.sh
fi
94 changes: 94 additions & 0 deletions docs/docusaurus.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,94 @@
module.exports = {
title: "Solana Program Library Docs",
tagline:
"Solana is an open source project implementing a new, high-performance, permissionless blockchain.",
url: "https://spl.solana.com",
baseUrl: "/",
favicon: "img/favicon.ico",
organizationName: "solana-labs", // Usually your GitHub org/user name.
projectName: "solana-program-library", // Usually your repo name.
themeConfig: {
navbar: {
logo: {
alt: "Solana Logo",
src: "img/logo-horizontal.svg",
srcDark: "img/logo-horizontal-dark.svg",
},
items: [
{
href: "https://docs.solana.com/",
label: "Docs »",
position: "left",
},
{
href: "https://solana.com/discord",
label: "Chat",
position: "right",
},

{
href: "https://github.com/solana-labs/solana-program-library",
label: "GitHub",
position: "right",
},
],
},
footer: {
style: "dark",
links: [
{
title: "Community",
items: [
{
label: "Discord",
href: "https://solana.com/discord",
},
{
label: "Twitter",
href: "https://twitter.com/solana",
},
{
label: "Forums",
href: "https://forums.solana.com",
},
],
},
{
title: "More",
items: [
{
label: "GitHub",
href: "https://github.com/solana-labs/solana-program-library",
},
],
},
],
copyright: `Copyright © ${new Date().getFullYear()} Solana Foundation`,
},
},
plugins: [require.resolve('docusaurus-lunr-search')],
presets: [
[
"@docusaurus/preset-classic",
{
docs: {
path: "src",
routeBasePath: "/",
sidebarPath: require.resolve("./sidebars.js"),
editUrl: ({ docPath }) => {
return `https://github.com/solana-labs/solana-program-library/edit/master/docs/src/${docPath}`;
}
},
theme: {
customCss: require.resolve("./src/css/custom.css"),
},
},
],
],
scripts: [
'https://buttons.github.io/buttons.js',
'https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js',
'/js/code-block-buttons.js',
],
stylesheets: ['/css/code-block-buttons.css'],
};
Loading