From 02d175cd95d669ce7ca7330cdb1395c51e4632ce Mon Sep 17 00:00:00 2001 From: Caleb Jasik Date: Wed, 16 Jun 2021 17:39:47 -0500 Subject: [PATCH] Update the shape of data provided by `Astro.fetchContent("./*.md")` (#479) --- docs/api.md | 20 +++++++++++++++----- 1 file changed, 15 insertions(+), 5 deletions(-) diff --git a/docs/api.md b/docs/api.md index 1d15dbf9e7..b511d473d4 100644 --- a/docs/api.md +++ b/docs/api.md @@ -27,12 +27,22 @@ const data = Astro.fetchContent('../pages/post/*.md'); // returns an array of po `.fetchContent()` only takes one parameter: a relative URL glob of which local files you’d like to import. Currently only `*.md` files are supported. It’s synchronous, and returns an array of items of type: -``` +```js { - url: string; // the URL of this item (if it’s in pages/) - content: string; // the HTML of this item - // frontmatter data expanded here -}[]; + /** frontmatter from the post.. example frontmatter: + title: '', + tag: '', + date: '', + image: '', + author: '', + description: '', + **/ + astro: { + headers: [], // TODO: document what this means + source: '' // raw source of the markdown file + }, + url: '' // the rendered path + }[] ``` #### `request`