--- layout: ~/layouts/Main.astro title: Getting Started --- Astro is a modern static site builder. Learn what Astro is all about from [our homepage](https://astro.build/) or [our release post](https://astro.build/blog/introducing-astro). This page is an overview of the Astro documentation and all related resources. Looking for a quick overview of what Astro is? [Visit our homepage.](https://astro.build) ## Try Astro The easiest way to try Astro is to run `npm init astro` in a new directory on your machine. Our CLI wizard will assist you in starting a new Astro project. To get started with Astro in 5 quickly and easy steps, visit our [Quick-Start guide](quick-start). Alternatively, read our [Installation Guide](/installation) for a full walk-through on getting set up with Astro. ### Online Playgrounds If you're interested in playing around with Astro in the browser, you can use an online code playground. Try our "Hello World!" template on [CodeSandbox](https://codesandbox.io/s/astro-template-hugb3). _Note: some features (ex: Fast Refresh) are currently limited on CodeSandbox._ ## Learn Astro All manner of people come to Astro from different backgrounds bringing with them different learning styles. Whether you prefer a more theoretical or a practical approach, we hope you'll find this section helpful. - If you prefer to **learn by doing**, start with our [examples library](https://github.com/snowpackjs/astro/tree/main/examples). - If you prefer to **learn concepts step by step**, start with our [basic concepts and guides](/core-concepts/project-structure). Like any unfamiliar technology, Astro comes with a slight learning curve. However, with practice and some patience, we know, you _will_ get the hang of it, in no time. ### Learn `.astro` Syntax When you begin to learn Astro, you'll see many files using the `.astro` file extension. This is **Astro's Component Syntax**: a special HTML-like file format which Astro uses for templating. It was designed to feel familiar to anyone with HTML or JSX experience. Our helpful guide on [Astro components](/core-concepts/astro-components) introduces you to the Astro syntax, and is the best way to learn. ### API Reference This documentation section is useful when you want to learn more details about a particular Astro API. For example, [Configuration Reference](/reference/configuration-reference) lists all possible configuration options available to you. [Built-in Components Reference](/reference/builtin-components) lists all available core components, like `` and ``. ### Versioned Documentation This documentation always reflects the latest stable version of Astro. Once we hit the v1.0 milestone, we will add the ability to view versioned documentation. ## Staying Informed The [@astrodotbuild](https://twitter.com/astrodotbuild) Twitter account is the official source for the updates from the Astro team. We also post release announcements to our [Discord community](https://astro.build/chat) in the #announcements channel. Not every Astro release deserves its own blog post, but you can find a detailed changelog for every release in the [`CHANGELOG.md` file in the Astro repository](https://github.com/snowpackjs/astro/blob/main/packages/astro/CHANGELOG.md). ## Something Missing? If something is missing in the documentation or if you found some part confusing, please [file an issue for the documentation](https://github.com/snowpackjs/astro/issues/new/choose) with your suggestions for improvement, or tweet at the [@astrodotbuild](https://twitter.com/astrodotbuild) Twitter account. We love hearing from you! ## Credit This getting started guide was originally based off of [React's](https://reactjs.org/) getting started guide. s/framework-alpine'>examples/framework-alpine Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
AgeCommit message (Expand)AuthorFilesLines
2021-07-19Fix url to find page with "index" at the end file name (#722) (#736)Gravatar Vl 5-1/+38
2021-07-19update changelog for patch releaseGravatar Fred K. Schott 1-0/+6
2021-07-20[ci] yarn formatGravatar FredKSchott 2-4/+2
2021-07-19tsconfig fix (#752)Gravatar Fred K. Schott 23-33/+49
2021-07-19docs/fix: add language to code block (#761)Gravatar Caleb Jasik 1-1/+1
2021-07-20[ci] yarn formatGravatar natemoo-re 1-4/+4
2021-07-19Improve docs theme (#717)Gravatar Nate Moore 11-744/+447
2021-07-19fix: :bug: ThemeToggle should initialize from localstorage immediately (#748)Gravatar Tony Sullivan 1-6/+6
2021-07-19[ci] yarn formatGravatar FredKSchott 1-26/+20
2021-07-19add comparison docs (#718)Gravatar Fred K. Schott 4-1/+201
2021-07-19small typo fixGravatar Fred K. Schott 1-1/+1
2021-07-18changed init example to correct template name (#744)Gravatar Mats 1-1/+1
2021-07-18fix: fixes prop href of author component in example blog, was url (#734)Gravatar Guilherme Siquinelli 1-1/+1
2021-07-17[ci] yarn formatGravatar FredKSchott 1-1/+1
2021-07-17Fix typos in the documentation. (#731)Gravatar mundry 13-30/+30
2021-07-17closing style tag (#730)Gravatar Seanghay 1-0/+1
2021-07-17feat(parser): remove trim utils (#728)Gravatar Carter Snook 2-20/+2
2021-07-16Fix githubEditUrl variable in `examples/docs`Gravatar Caleb Jasik 1-1/+1
2021-07-16[ci] yarn formatGravatar FredKSchott 2-14/+11
2021-07-16New getting started guideGravatar Fred K. Schott 10-25/+90
2021-07-16Revert "New getting started guide (#715)"Gravatar Fred K. Schott 20-411/+749
2021-07-16Revert "[ci] yarn format"Gravatar Fred K. Schott 3-15/+18
2021-07-16[ci] yarn formatGravatar natemoo-re 3-18/+15
2021-07-16New getting started guide (#715)Gravatar Fred K. Schott 20-749/+411
2021-07-16Update docs in compiler messages (#710)Gravatar Caleb Jasik 19-33/+33
2021-07-16Changed URLs to match the release (#711)Gravatar JuanM04 4-6/+6