Blog Mode: Disable or modify the date prefixes `/blog/2020/08/01/title-slug`.
See original GitHub issue🚀 Feature
For blog mode in Docusaurus V2, there should be a clean way to turn off the calendar date section within the URL path for each blog post, enabling more creative documentation use cases. In our own case we’ve built a “help center” (knowledge base) that would benefit from disabling the path prefix.
example.com/blog/2020/08/18/title-slug
==> example.com/blog/title-slug
Have you read the [Contributing Guidelines on issues]
Yes
Motivation
See help.getwisdom.io for a live example.
example.com/2020/08/18/title-slug
==> example.com/title-slug
Pitch
Docusaurus has a great blog framework with a tagging system and related tag list pages (/tags/) that in some ways make it a more powerful documentation approach to using docs with a sidebar. We are using the “blog mode” for Help Center like documentation, however each blog entry has a calendar entry time that doesn’t provide benefit:
- Aesthetics are poor in this case
- Semantics are not relevant, given that for us, these posts should be frequently updated (evergreen).
Currently, saving a markdown file without the filename date prefix appears to just default to UTC date instead of no date within the URL path.
Candidate Interfaces:
Possible Interfaces:
- string
path_prefix
: string prefix.null
defaulting to current date/blog/2020/08/01/title-slug
''
empty string produces no prefix (special case to not produce/blog//title-slug
)string1/string2
produces/blog/string1/string2/title-slug
- boolean
path_prefix
: Config to disable URL path prefix (currently calendar date) - function in
docusaurus.config.js
that sets the string prefix for each blog article(blog) => 'level1/level2';
. - Stop defaulting to UTC time if the file name is not prefixed with date.
Issue Analytics
- State:
- Created 3 years ago
- Comments:5 (2 by maintainers)
Yes we should:
test.mdx
: it should just lead to/blog/test
unless user is using slug frontmatterThanks
Yes you are right we need a way to have better control of blog slugs.
I tried this:
And the URL was this:
http://localhost:3000/blog/2020/08/11/heyyy
. In such case we’d rather simply not adding the date to the URL at all.Using markdown files without dates in filenames should be supported and not produce weird issues likes this.
We need a retrocompatible solution, and I’d be fine with 2 options:
Note: when using slugs, we should not prefix the slug of the user with a date. If they wants a date, they’ll add it to the slug.
In the long term we should encourage users to only use slugs and move out of this legacy url scheme
Someone wants to work on this?