https://github.com/withastro/docs

Astro documentation
https://github.com/withastro/docs

astro docs documentation website

Last synced: 2 days ago
JSON representation

Astro documentation

• Host: GitHub
• URL: https://github.com/withastro/docs
• Owner: withastro
• License: mit
• Created: 2021-06-16T05:06:57.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-10-29T13:25:01.000Z (about 1 month ago)
• Last Synced: 2024-10-29T13:27:44.211Z (about 1 month ago)
• Topics: astro, docs, documentation, website
• Language: MDX
• Homepage: https://docs.astro.build/
• Size: 97.8 MB
• Stars: 1,328
• Watchers: 23
• Forks: 1,484
• Open Issues: 49
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-repositories - withastro/docs - Astro documentation (MDX)

README

        
# Astro Docs 

To all who come to this happy place: welcome.

This is the repo for [docs.astro.build](https://docs.astro.build/).

This repo contains all the source code we use to build our docs site.

[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/withastro/docs)

[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/github/withastro/docs)

[![Open in Codeflow](https://developer.stackblitz.com/img/open_in_codeflow.svg)](https://pr.new/github.com/withastro/docs)

## We are Astro

Astro is an all-in-one web framework for building fast, content-focused websites.

We want everyone to be successful building sites, and that means helping everyone understand how Astro works.

## You are Awesome

You can also help make the docs awesome.

Your feedback is welcome.

Your writing, editing, translating, designing, and developing skills are welcome.

You being a part of our community is welcome.

## Chat with Us

You can learn more about Astro, get support, and meet other devs in [our Discord community](https://astro.build/chat).

## Raise an Issue

Is something missing?

Is something confusing?

Is something wrong?

Creating a new Issue puts a problem on our radar!

[See if your issue has already been reported](https://github.com/withastro/docs/issues), and if not, [create a new one](https://github.com/withastro/docs/issues/new/choose).

## Share an Idea

Could something be better?

Want to share an idea with us?

Discussions are threads where you can offer feedback on things that might not exactly be problems to be fixed but are ideas to be explored. 

[Join the Docs Discussions](https://github.com/withastro/docs/discussions) where we brainstorm, ask questions, share hopes and dreams...

## Make a Fix or Contribution

Did you find a typo, a broken link, or another item with an obvious quick fix?

If you can see what the problem is, and you know how to fix it, then you can make a PR (pull request) with the change and contribute to the docs repo yourself.

> Want to make a larger contribution? Please see [CONTRIBUTING.md](https://github.com/withastro/docs/blob/main/CONTRIBUTING.md) first! 

## Translate a Page

Speak another language natively? 

Join our i18n gang on Discord or jump into the PRs to help with reviewing existing draft translations!

Check out the dedicated [i18n guide](https://contribute.docs.astro.build/guides/i18n/) for more details.

## Next Steps

- [Read the docs](https://docs.astro.build/)

- [Raise an issue](https://github.com/withastro/docs/issues/new)

- [Participate in a discussion](https://github.com/withastro/docs/discussions)

- [Join the #docs channel on Discord](https://discord.gg/cZDZU3hJHc)