Developer documentation for the Plum Village App, a mobile application supporting mindfulness and meditation practices in the tradition of Thich Nhat Hanh and Plum Village.
This documentation site is built using Docusaurus, a modern static website generator.
The documentation covers code in many repositories, some of which are private. The documentation is therefore not yet useful for the general public, but we hope it will be more useful in the future once we make more of the code public.
The documentation is automatically deployed and available at: https://plumvillage.github.io/plumvillageapp-docs/
The Plum Village App provides guided meditations, teachings, and mindfulness resources to practitioners worldwide. This documentation serves as a comprehensive guide for developers contributing to the project.
- Node.js (>= 18.0)
- Yarn package manager
Install dependencies:
yarnStart the development server:
yarn startThis command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
We welcome contributions from the community! This project is part of our open source initiative to share mindfulness resources more widely.
- Follow the existing documentation structure and style
- Test your changes locally before submitting
- Ensure all links and references are working
- Commit directly to the
mainbranch with clear commit messages - For larger changes, consider creating a feature branch and submitting a pull request
- Fork the repository
- Create a feature branch
- Submit a pull request with a clear description of your changes
plumvillageapp-docs/
├── docs/ # Documentation content
├── src/ # Custom React components and styles
├── static/ # Static assets
└── docusaurus.config.ts # Site configuration
For questions or issues, create an issue in this repository
© 2025 Center For Applied Ethics Ltd.
This documentation is licensed under the Creative Commons Attribution 4.0 International License. You are free to share and adapt this material for any purpose, even commercially, as long as you provide appropriate attribution to the Center For Applied Ethics Ltd.
