lukechilds
/
docs
mirror of https://github.com/lukechilds/docs.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
898 Commits
80 Branches
0 Tags
152 MiB
 
 
Branch: fix/sections-for-cli-reference
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'fix/sections-for-cli-reference'
${ noResults }
Thomas Osmonson 0830049b5a
fix: heading ids 		4 years ago
.github/workflows feat: use fathom, meta improvements 4 years ago
lib feat: rehype-image-size, prevent image jump 4 years ago
public fix: fonts 4 years ago
src fix: heading ids 4 years ago
types refactor: use next.js 4 years ago
.eslintrc.js feat: pagination, feedback, remove action 4 years ago
.gitignore feat: shiki highlighting, content cleanup, component org 4 years ago
.prettierrc refactor: use next.js 4 years ago
.vercelignore feat: shiki highlighting, content cleanup, component org 4 years ago
README.md fix: readme updates 4 years ago
babel.config.js fix: more clean up, bundle size 4 years ago
next-env.d.ts refactor: use next.js 4 years ago
next.config.js fix: ios 4 years ago
package.json fix: update unified-vscode 4 years ago
tsconfig.json feat: pagination, feedback, remove action 4 years ago
yarn.lock fix: update unified-vscode 4 years ago

README.md

Blockstack documentation

A screenshot of docs.blockstack.org

Running and building the site locally

If you are interested in contributing to the site and making changes, please refer to our contributing guide here.

Generated documentation

Blockstack CLI reference

The src/_data/cli-reference.json file is generated from the blockstack-cli subcommand docs.

  1. Install the latest version of the cli according to the instructions at: https://github.com/blockstack/cli-blockstack

  2. Generate the json for the cli in the docs.blockstack repo.

    $ blockstack-cli docs > src/_data/cli-reference.json

Clarity Reference

There is a json file that is generated via the stacks-blockchain repo, which automatically brings it over to this repo via a github action.

FAQs

All of the FAQs found at /reference/faqs are pulled dynamically from the zendesk api and rendered in this project.