The official documentation for Evergreeners, the system designed to track developer consistency and cultivate your digital garden.
This site is built with Starlight and Astro.
You'll need Node.js (v18 or higher) and a package manager (npm, pnpm, or bun).
-
Clone the repository:
git clone https://github.com/evergreeners/Evergreeners-Docs.git cd Evergreeners-Docs -
Install dependencies:
npm install
-
Start the development server:
npm run dev
The documentation will be available at http://localhost:4321.
src/content/docs/: Contains all the documentation pages written in Markdown (.md) or MDX (.mdx).astro.config.mjs: Configuration for the Astro site and Starlight sidebar.public/: Static assets like icons and images.
We welcome contributions to the documentation!
- Create a new branch for your changes.
- Add or edit files in
src/content/docs/. - If you add new pages, update the sidebar in
astro.config.mjs. - Open a Pull Request with a clear description of your changes.
This documentation is open-source and licensed under the MIT License.
