diff options
Diffstat (limited to 'examples/blog/README.md')
| -rw-r--r-- | examples/blog/README.md | 49 |
1 files changed, 37 insertions, 12 deletions
diff --git a/examples/blog/README.md b/examples/blog/README.md index 09673cc3d..17657d99e 100644 --- a/examples/blog/README.md +++ b/examples/blog/README.md @@ -1,10 +1,8 @@ -# Astro Starter Kit: Blog +# Astro's Starter Kit: Blog -``` -npm init astro -- --template blog -``` +Welcome to Astro's Blog's Readme. This template is a straight forward way to launch your own Blogging site using Astro. We highly encourage you to explore the contents of this template and play about with it to make it your own. -> 🧑🚀 **Seasoned astronaut?** Delete this file. Have fun! +> 🧑🚀 **Seasoned Astronaut?** Delete this file. Have fun! Features: @@ -17,24 +15,47 @@ Features: Inside of your Astro project, you'll see the following folders and files: -``` +```bash / ├── public/ -│ ├── robots.txt +│ ├── assets/ +│ ├── blog.scss +│ ├── global.scss +│ ├── social.png +│ ├── social.jpg │ └── favicon.ico ├── src/ │ ├── components/ -│ │ └── Tour.astro +│ │ └── Author.astro +│ │ └── BaseHead.astro +│ │ └── BlogHeader.astro +│ │ └── BlogPost.astro +│ │ └── BlogPostPreview.astro +│ │ └── Logo.astro +│ └── layouts/ +│ │ └── BlogPost.astro │ └── pages/ +│ ├── posts/ +│ │ └── introducing-astro.astro │ └── index.astro └── package.json ``` -Astro looks for `.astro` or `.md` files in the `src/pages/` directory. Each page is exposed as a route based on its file name. +Files located within the public directory are static assets such as; stylesheets, images, fonts files etc. + +Located within the `src/` directory is the `components/` `layout/` and `pages/` directories. -There's nothing special about `src/components/`, but that's where we like to put any Astro/React/Vue/Svelte/Preact components. +The `src/components/` directory is where all you UI components are stored, this includes components from your framework of choice, whether they be: -Any static assets, like images, can be placed in the `public/` directory. +- Astro Components +- React +- Preact +- Solid +- Svelte Or Vue. + + You can visit our [Astro Components](https://docs.astro.build/core-concepts/astro-components) page for more information on creating your own components. + +Astro used file-based routing, this is done by having Astro look for `.astro` or `.md` files in the `src/pages/` directory. Each page is then exposed as a route based on its file name. To find out more about using [Pages with Astro](https://docs.astro.build/core-concepts/astro-pages) and how our file-based routing works. ## 🧞 Commands @@ -48,4 +69,8 @@ All commands are run from the root of the project, from a terminal: ## 👀 Want to learn more? -Feel free to check [our documentation](https://github.com/snowpackjs/astro) or jump into our [Discord server](https://astro.build/chat). +This Template can be used as a primary launch pad to get your own Blog site up and running with little effort as possible. Or as a educational demonstration. + +Regardless of your intentions, we simply wish for you to truly explore and learn how to get the most from Astro and this template has been created in such a way to allow you to do so. + +Feel free to check [our documentation](https://github.com/snowpackjs/astro) if you get stuck or jump into our [Discord server](https://astro.build/chat) to speak with other Astronauts. |