Skip to content

Commit

Permalink
docs: adds an explanation page (#41)
Browse files Browse the repository at this point in the history
Co-authored-by: Luiz Ferraz <11063910+Fryuni@users.noreply.github.com>
Co-authored-by: Florian Lefebvre <69633530+florian-lefebvre@users.noreply.github.com>
  • Loading branch information
3 people authored Feb 2, 2024
1 parent 3a20efe commit 54d129f
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 0 deletions.
4 changes: 4 additions & 0 deletions docs/astro.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,10 @@ export default defineConfig({
label: "Usage",
link: "/getting-started/usage/",
},
{
label: "Why Astro Integration Kit",
link: "/getting-started/why",
},
{
label: "Showcase",
link: "/getting-started/showcase/",
Expand Down
24 changes: 24 additions & 0 deletions docs/src/content/docs/getting-started/why.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
title: Why use Astro Integration Kit
description: Learn why you should use Astro Integration Kit to build your next Astro Integration.
---

Astro Integration Kit is a community-driven effort to improve the power, flexibility, and, most importantly, developer experience of creating Astro Integrations.

We are creating the Astro Integration Kit because we want to create a robust, battle-tested suite of tools to make creating Astro integrations easier in the hopes that one day, this will become part of the core Astro framework.

We constantly gather feedback from the entire community, from first-time integration builders to the seasoned Astro Core team.

Astro Integration Kit is currently an experimental technology that's still subject to changes as we solidify the APIs. However, it was built from techniques used in production-level integrations across the Astro Ecosystem.

Integrations typically require quite a low-level knowledge of Astro and Vite to be made successfully. So, Astro Integration Kit abstracts a lot of low-level implementation into easy-to-use utilities. Things such as Vite Virtual Modules or creating Typescript Declaration files for your users.

Small utilities allow you to adhere to best practices with the minimum amount of code.

Once we have a standard way of creating Astro Integrations, we can create content and guides much more easily using well-documented utilities, enabling more people to create more advanced integrations.

:::note
We are constantly looking for feedback and contributions from the community. Whether it's contributing code, ideas or suggestions; feel free to create an issue on [our GitHub repository](https://github.com/florian-lefebvre/astro-integration-kit).

Or get involved with the discussion on the [`#dev-integrations `channel](https://discord.com/channels/830184174198718474/1197638002764152843) of the official [Astro Discord server](https://astro.build/chat)!
:::

0 comments on commit 54d129f

Please sign in to comment.