Skip to content

Latest commit

 

History

History
251 lines (204 loc) · 7.44 KB

File metadata and controls

251 lines (204 loc) · 7.44 KB
type title description i18nReady
tutorial
Create a blog post archive
Tutorial: Build your first Astro blog — Use Astro.glob() to access data from files in your project
true

import Box from '/components/tutorial/Box.astro'; import Checklist from '/components/Checklist.astro'; import MultipleChoice from '/components/tutorial/MultipleChoice.astro'; import Option from '/components/tutorial/Option.astro'; import PreCheck from '~/components/tutorial/PreCheck.astro'; import { Steps } from '@astrojs/starlight/components';

Now that you have a few blog posts to link to, it's time to configure the Blog page to create a list of them automatically!

- Access data from all your posts at once using `Astro.glob()` - Display a dynamically generated list of posts on your Blog page - Refactor to use a `` component for each list item

Dynamically display a list of posts

1. Add the following code to `blog.astro` to return information about all your Markdown files. `Astro.glob()` will return an array of objects, one for each blog post.
```astro title="src/pages/blog.astro" ins={3}
---
import BaseLayout from '../layouts/BaseLayout.astro'
const allPosts = await Astro.glob('./posts/*.md');
const pageTitle = "My Astro Learning Blog";
---
<BaseLayout pageTitle={pageTitle}>
  <p>This is where I will post about my journey learning Astro.</p>
  <ul>
    <li><a href="/posts/post-1/">Post 1</a></li>
    <li><a href="/posts/post-2/">Post 2</a></li>
    <li><a href="/posts/post-3/">Post 3</a></li>
  </ul>
</BaseLayout>
  ```
  1. To generate the entire list of posts dynamically, using the post titles and URLs, replace your individual <li> tags with the following Astro code:

    ---
    import BaseLayout from '../layouts/BaseLayout.astro'
    const allPosts = await Astro.glob('../pages/posts/*.md');
    const pageTitle = "My Astro Learning Blog";
    ---
    <BaseLayout pageTitle={pageTitle}>
      <p>This is where I will post about my journey learning Astro.</p>
      <ul>
        <li><a href="/posts/post-1/">Post 1</a></li>
        <li><a href="/posts/post-2/">Post 2</a></li>
        <li><a href="/posts/post-3/">Post 3</a></li>
    
        {allPosts.map((post) => <li><a href={post.url}>{post.frontmatter.title}</a></li>)}
      </ul>
    </BaseLayout>

    Your entire list of blog posts is now being generated dynamically, by mapping over the array returned by Astro.glob().

  2. Add a new blog post by creating a new post-4.md file in src/pages/posts/ and adding some Markdown content. Be sure to include at least the frontmatter properties used below.

    ---
    layout: ../../layouts/MarkdownPostLayout.astro
    title: My Fourth Blog Post
    author: Astro Learner
    description: "This post will show up on its own!"
    image: 
        url: "https://docs.astro.build/default-og-image.png"
        alt: "The word astro against an illustration of planets and stars."
    pubDate: 2022-08-08
    tags: ["astro", "successes"]
    ---
    This post should show up with my other blog posts, because `Astro.glob()` is returning a list of all my posts in order to create my list.
  3. Revisit your blog page in your browser preview at http://localhost:4321/blog and look for an updated list with four items, including your new blog post!

Challenge: Create a BlogPost component

Try on your own to make all the necessary changes to your Astro project so that you can instead use the following code to generate your list of blog posts:

<ul>
  {allPosts.map((post) => <li><a href={post.url}>{post.frontmatter.title}</a></li>)}
  {allPosts.map((post) => <BlogPost url={post.url} title={post.frontmatter.title} />)}
</ul>
Expand to see the steps 1. Create a new component in `src/components/`.
<details>
<summary>Show the filename</summary>
```
BlogPost.astro
```
</details>
  1. Write the line of code in your component so that it will be able to receive a title and url as Astro.props.

    Show the code ```astro --- // src/components/BlogPost.astro const { title, url } = Astro.props; --- ```
  2. Add the templating used to create each item in your blog post list.

    Show the code ```astro
  3. {title}
  4. ```
  5. Import the new component into your Blog page.

    Show the code ```astro title="src/pages/blog.astro" ins={3} --- import BaseLayout from '../layouts/BaseLayout.astro'; import BlogPost from '../components/BlogPost.astro'; const allPosts = await Astro.glob('../pages/posts/*.md'); const pageTitle = "My Astro Learning Blog"; --- ```
  6. Check Yourself: see the finished component code.

    Show the code ```astro title="src/components/BlogPost.astro" --- const { title, url } = Astro.props ---
  7. {title}
  8. ``` ```astro title="src/pages/blog.astro" ins={3,10} --- import BaseLayout from '../layouts/BaseLayout.astro'; import BlogPost from '../components/BlogPost.astro'; const allPosts = await Astro.glob('../pages/posts/*.md'); const pageTitle = "My Astro Learning Blog" ---

    This is where I will post about my journey learning Astro.

      {allPosts.map((post) => )}
    ```

Test your knowledge

If your Astro component contains the following line of code:

---
const myPosts = await Astro.glob('./posts/*.md');
---

Choose the syntax you could write to represent:

  1. The title of your third blog post.

    `myPosts.map((post) => )` `myPosts[2].frontmatter.title` `First Post!!`
  2. A link to the URL of your first blog post.

    `myPosts.map((post) => )` `myPosts[2].frontmatter.title` `First Post!!`
  3. A component for each post, displaying the date that it was last updated.

    `myPosts.map((post) => )` `myPosts[2].frontmatter.title` `First Post!!`

Checklist

- [ ] I can query for data from my local files. - [ ] I can display a list of all my blog posts.

Resources