diff options
Diffstat (limited to 'examples/blog-multiple-authors')
| -rw-r--r-- | examples/blog-multiple-authors/README.md | 51 | ||||
| -rw-r--r-- | examples/blog-multiple-authors/package.json | 8 |
2 files changed, 49 insertions, 10 deletions
diff --git a/examples/blog-multiple-authors/README.md b/examples/blog-multiple-authors/README.md index 68f2e536b..39ae19683 100644 --- a/examples/blog-multiple-authors/README.md +++ b/examples/blog-multiple-authors/README.md @@ -1,8 +1,10 @@ # Astro Starter Kit: Blog with Multiple Authors -``` -npm init astro -- --template blog-multiple-authors -``` +Our Blog with Multiple Authors Template, is a working example of our Blog template being adapted to narrate the story of "Sancho Panza" and "Don Quixote". + +Here we display how you can use Astro to provide individual content for both Sancho Panza and Don Quixote. This is a great working example of our Collections API in action. + +We hope you enjoy this with a small Santeria, remember to build responsibly... > 🧑🚀 **Seasoned astronaut?** Delete this file. Have fun! @@ -18,23 +20,48 @@ Features: Inside of your Astro project, you'll see the following folders and files: ``` -/ ├── public/ -│ ├── robots.txt +│ ├── assets/ +│ ├── blog.scss +│ ├── global.scss +│ ├── social.png +│ ├── social.jpg │ └── favicon.ico ├── src/ │ ├── components/ -│ │ └── Tour.astro +│ │ └── MainHead.astro +│ │ └── Nav.astro +│ │ └── Pagination.astro +│ │ └── PostPreview.astro +│ └── layouts/ +│ │ └── post.astro │ └── pages/ +│ ├── posts/ +│ │ └── Series of Markdown files +│ └── $author.astro +│ └── $posts.astro +│ └── about.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. + +The `src/components/` directory is where all you UI components are stored, this includes components from your framework of choice, whether they be: -There's nothing special about `src/components/`, but that's where we like to put any Astro/React/Vue/Svelte/Preact components. +- Astro Components +- React +- Preact +- Solid +- Svelte Or Vue. -Any static assets, like images, can be placed in the `public/` directory. + 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](https://docs.astro.build/core-concepts/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 +75,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 solid platform 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. diff --git a/examples/blog-multiple-authors/package.json b/examples/blog-multiple-authors/package.json index 899294217..f52dca4af 100644 --- a/examples/blog-multiple-authors/package.json +++ b/examples/blog-multiple-authors/package.json @@ -2,6 +2,14 @@ "name": "@example/blog-multiple-authors", "version": "0.0.1", "private": true, + "description": "Use Case: Multiple Authors Blogging Site built using Astro", + "keywords": ["kitchen-sink","template","astro"], + "repository": { + "directory": "/examples/blog-multiple-authors", + "type": "github", + "url": "https://github.com/snowpackjs/astro/tree/main" + }, + "scripts": { "dev": "astro dev", "start": "astro dev", |