diff --git a/.changeset/pink-bees-add.md b/.changeset/pink-bees-add.md index 77c36cd..f13841e 100644 --- a/.changeset/pink-bees-add.md +++ b/.changeset/pink-bees-add.md @@ -1,5 +1,5 @@ --- -"@goulvenclech/astropi": minor +"@goulvenclech/astropi": patch --- Fix landing styles & content. diff --git a/README.md b/README.md index 8bff845..2c32e3d 100644 --- a/README.md +++ b/README.md @@ -1,38 +1,48 @@ # Astropi - Let's make a better doc 🪐 -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](https://astro.build/), a fast and modern Static Site Generator. +> [!WARNING] +> Astropi is in early development and is not ready for public use... but new contributors are welcome! -## 🚀 How to use Astropi +[Astropi](https://astropi.goulven-clech.dev/) is a free and open-source project that helps you build beautiful and accessible API documentation for your projects. It's built with [Astro](https://astro.build/), 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: ```bash +# 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 -# If you use pnpm -pnpm create astro --template github:goulvenclech/astropi/starter ``` Or add Astropi to an existing Astro project: ```bash +# 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 -# If you use pnpm -pnpm astro add @goulvenclech/astropi ``` -From there, read the generated `README.md` in your new project, or check out the [Astropi documentation](https://astropi.dev) for more information. +## How to use -## 👷 How to contribute +Check out the [Astropi documentation](https://astropi.goulven-clech.dev/) for more information. Here are some quick links: -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 idea or suggestions, please open or join [a discussion](). +- [Getting Started](https://astropi.goulven-clech.dev/learn/2-getting-started) +- [Creating a blog](https://astropi.goulven-clech.dev/learn/3-create-a-blog) -If you want to contribute to Astropi, please read the [Contributing Guide](./CONTRIBUTING.md) and the [Code of Conduct](./CODE_OF_CONDUCT.md) before submitting a pull request. You can find more technical information about the project in the `README.md` files of each main directory: +## 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](https://github.com/goulvenclech/astropi/issues). If you have any suggestions, please [open a discussion](https://github.com/goulvenclech/astropi/discussions). + +If you want to contribute to Astropi, please read the [Contributing Guide](./CONTRIBUTING.md) (work in progress) and the [Code of Conduct](./CODE_OF_CONDUCT.md) 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. @@ -40,14 +50,12 @@ If you want to contribute to Astropi, please read the [Contributing Guide](./CON - `./packages/astropi-starter/` contains the Astropi starter template, which is cloned when you create a new Astropi project. -## ⚖️ License +## License Astropi is licensed under the [MIT License](./LICENSE.md). 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 +## Aknowledgements Thanks [Astro](https://astro.build/) for being the core of Astropi and an amazing Static Site Generator. -Thanks [Starlight](https://starlight.astro.build) for being the main inspiration for Astropi and our example of Astro Integration. - -Thanks [Readme.so](https://readme.so/) and [VitePress](https://vitepress.vuejs.org/) for inspiring us in the documentation design. +Thanks [Starlight](https://starlight.astro.build) for being the main inspiration for Astropi, alongside other documentation tools like [Readme.com](https://readme.com/), [GitBook](https://docs.gitbook.com/), [VitePress](https://vitepress.vuejs.org/), etc. diff --git a/docs/src/content/learn/1-install.md b/docs/src/content/learn/1-install.md index f96db6e..52f9a74 100644 --- a/docs/src/content/learn/1-install.md +++ b/docs/src/content/learn/1-install.md @@ -9,12 +9,12 @@ Welcome to Astropi 🪐 Create a new Astropi project by running the following command: ```bash +# 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 -# If you use pnpm -pnpm create astro --template github:goulvenclech/astropi/starter ``` ## Add to an existing project @@ -22,12 +22,12 @@ pnpm create astro --template github:goulvenclech/astropi/starter Alternatively, you can add Astropi to an existing Astro project: ```bash +# 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 -# If you use pnpm -pnpm astro add @goulvenclech/astropi ``` But please make sure thare our generated routes are not conflicting with yours. diff --git a/docs/src/content/learn/2-getting-started.md b/docs/src/content/learn/2-getting-started.md index 20a32af..b4618ef 100644 --- a/docs/src/content/learn/2-getting-started.md +++ b/docs/src/content/learn/2-getting-started.md @@ -21,6 +21,8 @@ your_project/ ```bash # Start the development server npm run dev +# Build the project +npm run build ``` diff --git a/packages/astropi/README.md b/packages/astropi/README.md index 6090e7d..3c33e50 100644 --- a/packages/astropi/README.md +++ b/packages/astropi/README.md @@ -1,31 +1,61 @@ # Astropi - Let's make a better doc 🪐 -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](https://astro.build/), a fast and modern Static Site Generator. +> [!WARNING] +> Astropi is in early development and is not ready for public use... but new contributors are welcome! + +[Astropi](https://astropi.goulven-clech.dev/) is a free and open-source project that helps you build beautiful and accessible API documentation for your projects. It's built with [Astro](https://astro.build/), a fast and modern Static Site Generator. This core package contains the components, styles, and utilities that power the project. -## 🚀 How to use Astropi +## How to install Create a new Astropi project by running the following command: ```bash +# 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 -# If you use pnpm -pnpm create astro --template github:goulvenclech/astropi/starter ``` Or add Astropi to an existing Astro project: ```bash +# 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 -# If you use pnpm -pnpm astro add @goulvenclech/astropi ``` -From there, read the generated `README.md` in your new project, or check out the [Astropi documentation](https://astropi.goulven-clech.dev) for more information. \ No newline at end of file +## How to use + +Check out the [Astropi documentation](https://astropi.goulven-clech.dev/) for more information. Here are some quick links: + +- [Getting Started](https://astropi.goulven-clech.dev/learn/2-getting-started) +- [Creating a blog](https://astropi.goulven-clech.dev/learn/3-create-a-blog) + +## 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](https://github.com/goulvenclech/astropi/issues). If you have any suggestions, please [open a discussion](https://github.com/goulvenclech/astropi/discussions). + +If you want to contribute to Astropi, please read the [Contributing Guide](./CONTRIBUTING.md) (work in progress) and the [Code of Conduct](./CODE_OF_CONDUCT.md) 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](./LICENSE.md). 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](https://astro.build/) for being the core of Astropi and an amazing Static Site Generator. + +Thanks [Starlight](https://starlight.astro.build) for being the main inspiration for Astropi, alongside other documentation tools like [Readme.com](https://readme.com/), [GitBook](https://docs.gitbook.com/), [VitePress](https://vitepress.vuejs.org/), etc.