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

feat(v2): blog slug frontmatter (#3284)

Browse source
This commit is contained in:
Jean-Marc Saad 2020-08-20 15:59:54 +03:00 • committed by GitHub
parent 0f357606cd
commit 3ea2f8cfde
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
16 changed files with 107 additions and 27 deletions
Download patch file Download diff file Expand all files Collapse all files

19
docs/guides-blog.md
View file

@ -34,6 +34,24 @@ authorTwitter: JoelMarcey
Lorem Ipsum...
```
Adding slug will override the url of the blog post.
For example:
```yml
---
slug: introducing-docusaurus
title: Introducing Docusaurus
author: Joel Marcey
authorURL: http://twitter.com/JoelMarcey
authorFBID: 611217057
authorTwitter: JoelMarcey
---
Lorem Ipsum...
```
Will be available at `https://website/blog/introducing-docusaurus`
## Header Options
The only required field is `title`; however, we provide options to add author information to your blog post as well along with other options.
@ -43,6 +61,7 @@ The only required field is `title`; however, we provide options to add author in
- `authorFBID` - The Facebook profile ID that is used to fetch the profile picture.
- `authorImageURL` - The URL to the author's image. (Note: If you use both `authorFBID` and `authorImageURL`, `authorFBID` will take precedence. Don't include `authorFBID` if you want `authorImageURL` to appear.)
- `title` - The blog post title.
- `slug` - The blog post url slug. Example: `/blog/my-test-slug`. When not specified, the blog url slug will be extracted from the file name.
- `unlisted` - The post will be accessible by directly visiting the URL but will not show up in the sidebar in the final build; during local development, the post will still be listed. Useful in situations where you want to share a WIP post with others for feedback.
## Summary Truncation