Source code for the CosId documentation site. This repository contains the documentation for CosId, a universal, flexible, and high-performance distributed ID generator.
pnpm install
pnpm run docs:devpnpm run docs:dev # Start development server with hot reload
pnpm run docs:build # Build documentation for production
pnpm run docs:preview # Preview production build locallydocs/
├── en/ # English documentation
│ ├── guide/ # Getting started, guides, tutorials
│ │ ├── getting-started.md
│ │ ├── introduction.md
│ │ ├── cosid-generator.md
│ │ ├── segment.md
│ │ ├── segment-chain.md
│ │ ├── snowflake.md
│ │ ├── id-converter.md
│ │ ├── provider.md
│ │ ├── advanced/
│ │ ├── extensions/
│ │ ├── faq/
│ │ └── sharding/
│ ├── reference/ # Configuration reference
│ │ └── config/
│ ├── public/ # Static assets (images, logos)
│ └── index.md # Home page
└── zh/ # Chinese documentation
├── guide/
├── reference/
├── public/
└── index.md
Contributions to improve documentation are welcome! Please refer to the main CosId project's Contributing Guide for more details.