Welcome to the documentation portal for the CoMapeo platform. This site is built with Docusaurus, which powers a modern static website and supports features like multilingual content and automatic Markdown generation from our Notion database.
Install all dependencies with:
bun i
Before proceeding to local development, set up your environment and fetch the latest Notion Markdown files:
- Rename (or copy) .env.example to .env and update it with your Notion API key and Database ID.
- Fetch the Notion Markdown documentation by running:
bun notionToMd
Launch a local development server with live reloading by running:
bun dev
This command opens your browser automatically and reflects changes immediately.
Compile all content—including Markdown files fetched from Notion and integrated translations—into static assets by running:
bun build
The resulting files are placed in the build directory for deployment via any static hosting service.
Deploy your site using one of the following methods:
- Using SSH:
USE_SSH=true bun deploy
- Without SSH (using GitHub credentials):
GIT_USER=<Your GitHub username> bun deploy
For GitHub Pages hosting, this command conveniently builds the site and pushes to the gh-pages branch.
- Develop a robust translation strategy to further enhance our multilingual support.
- Integrate GitHub Actions for continuous deployment and automated publishing.
- Refine the Notion-to-Markdown integration for more dynamic updates.