Skip to content

Commit

Permalink
docs(content-blog) Document flattenFolders API
Browse files Browse the repository at this point in the history
  • Loading branch information
GingerGeek committed Mar 20, 2024
1 parent 2d7ed4a commit c6f31d3
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions website/docs/api/plugins/plugin-content-blog.mdx
Expand Up @@ -75,6 +75,7 @@ Accepted fields:
| `feedOptions.copyright` | `string` | `undefined` | Copyright message. |
| `feedOptions.language` | `string` (See [documentation](http://www.w3.org/TR/REC-html40/struct/dirlang.html#langcodes) for possible values) | `undefined` | Language metadata of the feed. |
| `sortPosts` | <code>'descending' \| 'ascending' </code> | `'descending'` | Governs the direction of blog post sorting. |
| `flattenFolders` | `boolean` | `false` | When true, nested folders in `path` are discarded when autogenerating slugs. Useful if you want to organise your blog folder by date (or something else) without it impacting/breaking the slugs on the site |

Check failure on line 78 in website/docs/api/plugins/plugin-content-blog.mdx

View workflow job for this annotation

GitHub Actions / Lint

Unknown word (organise) -- Useful if you want to organise your blog folder by
| `processBlogPosts` | <code>[ProcessBlogPostsFn](#ProcessBlogPostsFn)</code> | `undefined` | An optional function which can be used to transform blog posts (filter, modify, delete, etc...). |
| `showLastUpdateAuthor` | `boolean` | `false` | Whether to display the author who last updated the blog post. |
| `showLastUpdateTime` | `boolean` | `false` | Whether to display the last date the blog post was updated. This requires access to git history during the build, so will not work correctly with shallow clones (a common default for CI systems). With GitHub `actions/checkout`, use`fetch-depth: 0`. |
Expand Down Expand Up @@ -176,6 +177,7 @@ const config = {
'**/*.test.{js,jsx,ts,tsx}',
'**/__tests__/**',
],
flattenFolders: true,
postsPerPage: 10,
blogListComponent: '@theme/BlogListPage',
blogPostComponent: '@theme/BlogPostPage',
Expand Down

0 comments on commit c6f31d3

Please sign in to comment.