Skip to content

Latest commit

 

History

History
61 lines (39 loc) · 2.99 KB

README.md

File metadata and controls

61 lines (39 loc) · 2.99 KB
Raw

Astropi - Let's make a better doc 🪐

Warning

Astropi is in early development and is not ready for public use... but new contributors are welcome!

Astropi is a free and open-source project that helps you build beautiful and accessible API documentation for your projects. It's built with Astro, a fast and modern Static Site Generator.

This mono-repository contains the core of Astropi, the documentation website, and the starter template. You can find more information about each part of the project in the README.md files of each main directory.

How to install

Create a new Astropi project by running the following command:

# If you use pnpm
pnpm create astro --template github:goulvenclech/astropi/starter
# If you use npm
npm create astro --template github:goulvenclech/astropi/starter
# If you use yarn
yarn create astro --template github:goulvenclech/astropi/starter

Or add Astropi to an existing Astro project:

# If you use pnpm
pnpm astro add @goulvenclech/astropi
# If you use npm
npx astro add @goulvenclech/astropi
# If you use yarn
yarn astro add @goulvenclech/astropi

How to use

Check out the Astropi documentation for more information. Here are some quick links:

How to contribute

Astropi is a community-driven project, and we welcome contributions of all kinds. If you experience any problem with our project, please open an issue. If you have any suggestions, please open a discussion.

If you want to contribute to Astropi, please read the Contributing Guide (work in progress) and the Code of Conduct before submitting a pull request. You can find more technical information about the project in the README.md files of each main directory:

  • ./packages/astropi/ contains the core of Astropi, including the components, styles, and utilities that power the project.

  • ./docs/ contains the Astropi documentation website (built with Astropi!)

  • ./packages/astropi-starter/ contains the Astropi starter template, which is cloned when you create a new Astropi project.

License

Astropi is licensed under the MIT License. You are free to use, modify, and distribute this project. You must include the original license in any fork of this project. Attribution is appreciated.

Aknowledgements

Thanks Astro for being the core of Astropi and an amazing Static Site Generator.

Thanks Starlight for being the main inspiration for Astropi, alongside other documentation tools like Readme.com, GitBook, VitePress, etc.