Codex documentation

Welcome to Codex documentation.

Codex is a decentralised data storage platform that provides exceptionally strong censorship resistance and durability guarantees.

Run and build

For documentation we use VitePress, which is Vue-powered static site generator built on top of Vite.

To run site locally, we should clone repository, install dependencies and run the following command

npm run docs:dev

Detailed guide

1. Install node 20 or above

   Using nvm

   # nvm
   curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.0/install.sh | bash
   
   # Node 22
   nvm install 22
   nvm use 22
   
   # Check
   node --version
   v22.6.0
   

2. Clone repository

   git clone https://github.com/codex-storage/codex-docs
   cd codex-docs
   

3. Install dependencies

   npm install
   

4. Start a local dev server with instant hot updates

   # Local
   npm run docs:dev
   
   # Expose
   npm run docs:dev -- --host
   

5. Build the site

   npm run docs:build
   
   # .vitepress/dist
   

Contribute

Please check VitePress documentation for more details about customizations.

Process

• Create a fork
• Create a custom branch in your fork
• Add your contribution
• Make a PR to the upstream repository

Project structure

• learn - All information to learn about Codex
• networks - Codex networks related information
• developers - Codex development process and guides