This repository contains the documentation website for MemOS project.
MemOS-Docs/ ├── app/ # Main application code │ ├── components/ # Vue components │ ├── composables/ # Vue composables │ ├── pages/ # Vue pages and routing │ └── assets/ # Static assets like CSS ├── content/ # Documentation content │ ├── en/ # English documentation │ ├── cn/ # Chinese documentation │ └── api.json # OpenAPI Documentation ├── public/ # Public static assets │ └── assets/ # Images and other media ├── envConfig/ # Environment configurations │ ├── config.dev.ts # Development config │ ├── config.pre.ts # Pre-production config │ └── config.prod.ts # Production config ├── i18n/ # Internationalization │ └── locales/ # Translation files └── nuxt.config.ts # Nuxt configuration - 📝 Markdown-based documentation
- 🌐 Multi-language support (English & Chinese)
- 🔍 Full-text search
- 📱 Mobile-friendly responsive design
- ⚡️ Fast static site generation
Make sure to install the dependencies:
pnpm installStart the development server on http://localhost:3000:
pnpm devBuild the documentation site:
# Build with default settings (en locale, dev environment) pnpm run publish # Build for specific environment pnpm run publish --env=prod The project supports different environments:
dev: Development environmentpre: Pre-production environmentprod: Production environment
Configure environment-specific settings in envConfig/config.[env].ts.
Documentation is written in Markdown format and organized by language:
- English docs:
content/en/ - Chinese docs:
content/cn/
Navigation structure is defined in content/[lang]/settings.yml.
- Fork the repository
- Create your feature branch
- Commit your changes
- Push to the branch
- Create a Pull Request