3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-07-29 06:29:03 +02:00
Code Issues Projects Releases Packages Wiki Activity

docs: add description on blog post file/folder naming conventions and date extraction patterns (#8845)

Browse source 
Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
This commit is contained in:
Chua Chee How 2023-04-06 21:51:01 +08:00 • committed by GitHub
parent 1d42955d67
commit 46d2aa231d
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

6
website/docs/blog.mdx
View file

@ -144,10 +144,10 @@ module.exports = {
## Blog post date {#blog-post-date}
Docusaurus will extract a `YYYY-MM-DD` date from a file/folder name such as `YYYY-MM-DD-my-blog-post-title.md`.
Docusaurus will extract a `YYYY-MM-DD` date from many patterns such as `YYYY-MM-DD-my-blog-post-title.md` or `YYYY/MM/DD/my-blog-post-title.md`. This enables you to easily group blog posts by year, by month, or to use a flat structure.
<details>
<summary>Example supported patterns</summary>
<summary>Supported date extraction patterns</summary>
| Pattern | Example |
| --- | --- |
@ -160,7 +160,7 @@ Docusaurus will extract a `YYYY-MM-DD` date from a file/folder name such as `YYY
| Nested folders + `index.md` | `2021/05/28/my-blog-post-title/index.md` |
| Date in the middle of path | `category/2021/05-28-my-blog-post-title.md` |
The date will be excised from the path and appended to the beginning of the URL slug.
Docusaurus can extract the date from the posts using any of the naming patterns above. It is advisable to choose one pattern and apply it to all posts to avoid confusion.
</details>