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