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.
1247 Commits
80 Branches
0 Tags
152 MiB
 
 
Tree: c8b32dee95
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'c8b32dee95'
${ noResults }
Mark Hendrickson c8b32dee95
feat: restructure "Build apps" section 		4 years ago
.github fix: run only when MD files were changed 4 years ago
.vale docs: style improvements 4 years ago
lib feat: rehype-image-size, prevent image jump 4 years ago
public docs: mainnet changes for running node and miner 4 years ago
src feat: restructure "Build apps" section 4 years ago
types refactor: use next.js 4 years ago
.eslintrc.js fix: deps, redirect, spacing for custom block 4 years ago
.gitignore fix: add newline to gitignore 4 years ago
.gitpod.yml fix: format yaml file 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: rename vale check style 4 years ago
babel.config.js feat: emotion, @stacks/ui & ui-core 4 years ago
mlc_config.json feat: add URL checker and fix broken URLs 4 years ago
next-env.d.ts refactor: use next.js 4 years ago
next.config.js fix: deps, redirect, spacing for custom block 4 years ago
package.json fix: deps, redirect, spacing for custom block 4 years ago
tsconfig.json feat: emotion, @stacks/ui & ui-core 4 years ago
yarn.lock fix: deps, redirect, spacing for custom block 4 years ago

README.md

Gitpod ready-to-code

Stacks 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

Style checks

This repository uses vale to run style checks. Make sure to install the tool and run the following command before creating a PR in order to check for styling issues:

yarn check:style

Blockstack CLI reference

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

  1. Install the latest version of the cli according to the instructions at: https://github.com/blockstack/stacks.js/tree/master/packages/cli

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

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