Nervos CKB Documentation Website

• Nervos CKB Documentation Website
  • What is CKB
  • Contributing
    • Branches
    • Code structure
    • Develop
      • Clone the Repo
      • Install Dependencies
      • Run the website
      • Build for deployment
      • Maintain key-terms.json file
    • Broken Link Checker

What is CKB

Nervos CKB is a public permissionless blockchain and the layer 1 of Nervos.

CKB generates trust and extends this trust to upper layers, making Nervos a trust network. It's also the value store of the Nervos network, providing public, secure and censorship-resistant custody services for assets, identities and other common knowledge created in the network. We will also vigorously develop the developer community and aim to offer blockchain developers exciting new capabilities.

If you run into an issue on our documentation website you can contact us on Nervos talk or Discord.

Contributing

Branches

• production branch: master
• latest developing branch: develop
  • Live Preview: https://nervos-ckb-docs-git-develop-cryptape.vercel.app/

Code structure

• website: The doc site is built with docusaurus and under the website folder.
• examples: The examples folder contains full tutorial codes you can clone.

Develop

Clone the Repo

git clone https://github.com/nervosnetwork/docs.nervos.org.git
cd docs.nervos.org
cd website

Install Dependencies

Install yarn.

In website folder:

yarn install

Run the website

In website folder:

yarn start

[INFO] Starting the development server...
[SUCCESS] Docusaurus website is running at: http://localhost:3000/

You can check out the website at http://localhost:3000/ in your browser now.

Build for deployment

In website folder:

yarn build

Maintain key-terms.json file

The key-terms.json file is generated from the glossary in the docs/tech-explanation/glossary.md file. This file is used by the Tooltip component to provide definitions and links to key terms throughout the documentation.

Once you have updates in glossary.md, please remember to run the following command in the website folder to re-generate the key-terms.json file:

yarn gen-terms

After running the command, you can navigate to src/components/Tooltip to verify that the key-terms.json file has been generated successfully.

Broken Link Checker

Use ./scripts/check-urls.sh to scan for dead links.

How to Use

1. Install lychee.
2. Build the website: cd website && yarn build.
3. Run the script: ./scripts/check-urls.sh.

The script prints any links that fail the check.

Notes

• A cache file ./website/.lycheecache will be created. For local development, the cache TTL is 30 days; you can change max_cache_age in website/.lychee.toml.
• Because the docs contain many GitHub links, requests are routed via api.github.com. Providing a GitHub token increases the rate limit.
• For this reason, the check is not integrated into CI at the moment.