Skip to content

Latest commit

 

History

6 Commits

Folders and files

Repository files navigation

Evergreeners Logo

Evergreeners Documentation

Track your consistency. Grow your legacy.

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.

🚀 Getting Started

Prerequisites

You'll need Node.js (v18 or higher) and a package manager (npm, pnpm, or bun).

Installation

  1. Clone the repository:

    git clone https://github.com/evergreeners/Evergreeners-Docs.git
    cd Evergreeners-Docs
  2. Install dependencies:

    npm install
  3. Start the development server:

    npm run dev

The documentation will be available at http://localhost:4321.

📂 Project Structure

  • 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.

🤝 Contributing

We welcome contributions to the documentation!

  1. Create a new branch for your changes.
  2. Add or edit files in src/content/docs/.
  3. If you add new pages, update the sidebar in astro.config.mjs.
  4. Open a Pull Request with a clear description of your changes.

📄 License

This documentation is open-source and licensed under the MIT License.

Releases

Packages

Contributors

Languages