summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGravatar Dan Jutan <danjutan@gmail.com> 2022-06-15 11:32:40 -0400
committerGravatar GitHub <noreply@github.com> 2022-06-15 10:32:40 -0500
commit8ed924d2ed21a6e2e6df9345b7315d05da866b54 (patch)
treea9c97fe1736156be061d9a582b7d34d24e7754f5
parent0ffc350c8d6bcf7fe4f6bde7ce1c10c014d7b4a1 (diff)
downloadastro-8ed924d2ed21a6e2e6df9345b7315d05da866b54.tar.gz
astro-8ed924d2ed21a6e2e6df9345b7315d05da866b54.tar.zst
astro-8ed924d2ed21a6e2e6df9345b7315d05da866b54.zip
Update README.md (#3597)
- Fix the tree to reflect the actual example contents - Remove RSS and Sitemap bullet points, since they aren't in the project
-rw-r--r--examples/blog/README.md41
1 files changed, 29 insertions, 12 deletions
diff --git a/examples/blog/README.md b/examples/blog/README.md
index f04b05529..7d7183a9f 100644
--- a/examples/blog/README.md
+++ b/examples/blog/README.md
@@ -12,24 +12,41 @@ Features:
- ✅ SEO-friendly setup with canonical URLs and OpenGraph data
- ✅ Full Markdown support
-- ✅ RSS 2.0 generation
-- ✅ Sitemap.xml generation
## 🚀 Project Structure
Inside of your Astro project, you'll see the following folders and files:
```
-/
-├── public/
-│ ├── robots.txt
-│ └── favicon.ico
-├── src/
-│ ├── components/
-│ │ └── Tour.astro
-│ └── pages/
-│ └── index.astro
-└── package.json
+├── README.md
+├── astro.config.mjs
+├── package.json
+├── public
+│   ├── assets
+│   │   └── blog
+│   │   └── introducing-astro.jpg
+│   ├── favicon.ico
+│   ├── social.jpg
+│   └── social.png
+├── sandbox.config.json
+├── src
+│   ├── components
+│   │   ├── Author.astro
+│   │   ├── BaseHead.astro
+│   │   ├── BlogHeader.astro
+│   │   ├── BlogPost.astro
+│   │   ├── BlogPostPreview.astro
+│   │   ├── Heading.astro
+│   │   └── Logo.astro
+│   ├── layouts
+│   │   └── BlogPost.astro
+│   ├── pages
+│   │   ├── index.astro
+│   │   └── posts
+│   │   └── index.md
+│   └── styles
+│   └── blog.css
+└── tsconfig.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.