Official documentation website for Replane - dynamic configuration for apps and services.

• Docusaurus V3 - Documentation framework
• TailwindCSS V4 - Styling
• Shadcn/UI - Component library
• OpenAPI Docs - Auto-generated API reference from OpenAPI spec
• Local Search - Full-text search powered by @easyops-cn/docusaurus-search-local

• Node.js 18+
• npm, yarn, or pnpm

1. Clone the repository:

git clone https://github.com/replane-dev/replane-website.git
cd replane-website

2. Install dependencies:

npm install
# or
yarn install
# or
pnpm install

3. Start the development server:

npm start

The site will open at http://localhost:8080.

Generate a production build:

npm run build

Serve the production build locally:

npm run serve

replane-website/
├── api-swagger/          # OpenAPI specification files
│   └── replane.yaml      # Replane API spec
├── blog/                 # Blog posts
├── docs/                 # Documentation content
│   ├── getting-started/  # Quickstart and installation guides
│   ├── concepts/         # Core concepts and architecture
│   ├── self-hosting/     # Deployment guides
│   ├── guides/           # Use case guides
│   ├── sdk/              # SDK documentation
│   └── api/              # Generated API reference
├── src/
│   ├── components/       # React components
│   │   ├── ui/           # Shadcn/UI components
│   │   └── Homepage/     # Homepage components
│   ├── css/              # Styles
│   ├── pages/            # Custom pages
│   ├── plugins/          # Docusaurus plugins
│   └── theme/            # Theme customizations
├── static/               # Static assets
└── docusaurus.config.js  # Docusaurus configuration

The API reference is automatically generated from the OpenAPI specification:

# Generate API docs
npm run gen-api-docs

# Clean generated API docs
npm run clean-api-docs

The OpenAPI spec is located at api-swagger/replane.yaml. After updating it, regenerate the docs.

1. Create a new Markdown file in the appropriate docs/ subdirectory
2. Add frontmatter with metadata:

---
sidebar_position: 1
title: Your Page Title
---

# Your Page Title

Your content here...

3. The page will automatically appear in the sidebar based on the directory structure

Use absolute paths for links to ensure they work correctly:

[Link text](/docs/path/to/page)

Avoid relative links like ./page or ../other/page as they may break with trailingSlash: false.

Place images in static/img/ and reference them:

![Alt text](/img/your-image.png)

Main configuration is in docusaurus.config.js:

• Site metadata (title, tagline, URL)
• Theme configuration
• Plugin settings
• Navigation and footer links

• TailwindCSS configuration is in src/css/custom.css (v4)
• Custom CSS variables and overrides are also in custom.css
• Shadcn/UI components are in src/components/ui/

The local search is configured to:

• Index all pages including docs and blog
• Support keyboard shortcuts (Cmd/Ctrl + K)
• Provide search suggestions
• Highlight search terms

The site is configured for deployment to static hosting platforms:

1. Push to GitHub
2. Import the repository in Vercel
3. Vercel will auto-detect Docusaurus and deploy

npm run build
# Upload the 'build' directory to your hosting provider

Contributions to the documentation are welcome!

1. Fork the repository
2. Create a feature branch: git checkout -b docs/your-improvement
3. Make your changes
4. Test locally: npm start
5. Build to check for errors: npm run build
6. Submit a pull request

• Use clear, concise language
• Include code examples where appropriate
• Add screenshots for UI walkthroughs
• Test all links and code snippets
• Follow the existing structure and formatting

See CONTRIBUTING.md for development setup and contribution guidelines.

Have questions or want to discuss Replane? Join the conversation in GitHub Discussions.

• Replane Main Repository
• Docusaurus Documentation
• TailwindCSS Documentation
• Shadcn/UI Documentation

MIT