mirror of
https://github.com/facebook/docusaurus.git
synced 2025-07-28 14:08:21 +02:00
Update structure of blog guide
This commit is contained in:
parent
1f1d1448b2
commit
5f6dab0b6c
1 changed files with 15 additions and 11 deletions
|
@ -17,11 +17,12 @@ headerLinks: [
|
|||
]
|
||||
```
|
||||
|
||||
## Adding blog posts
|
||||
|
||||
## Adding Posts
|
||||
|
||||
To publish in the blog, create a file within the blog folder with a formatted name of `YYYY-MM-DD-My-Blog-Post-Title.md`. The post date is extracted from the file name.
|
||||
|
||||
For example, we will create the following file `website/blog/2017-08-18-Introducing-Docusaurus.md`:
|
||||
For example, at `website/blog/2017-08-18-Introducing-Docusaurus.md`:
|
||||
|
||||
```
|
||||
---
|
||||
|
@ -34,7 +35,18 @@ title: Introducing Docusaurus
|
|||
Lorem Ipusm..
|
||||
```
|
||||
|
||||
## Blog Post Summaries
|
||||
|
||||
## Header Options
|
||||
|
||||
The only required field is `title`; however, we provide options to add author information to your blog post as well.
|
||||
|
||||
- `author` - The text label of the author byline.
|
||||
- `authorURL` - The url associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
|
||||
- `authorFBID` - The Facebook ID that is used to extract the profile picture.
|
||||
- `title` - The blog post title.
|
||||
|
||||
|
||||
## Summary Truncation
|
||||
|
||||
Use the `<!--truncate-->` marker in your blog post to represent what will be shown as the summary when viewing all blog published blog posts. Anything above `<!--truncate-->` will be part of the summary. For example:
|
||||
|
||||
|
@ -55,11 +67,3 @@ Not this.
|
|||
|
||||
Or this.
|
||||
```
|
||||
## Special blog post header options
|
||||
|
||||
The only required field is `title`; however, we provide options to add author information to your blog post as well.
|
||||
|
||||
- `author` - The text label of the author byline.
|
||||
- `authorURL` - The url associated with the author. This could be a Twitter, GitHub, Facebook account, etc.
|
||||
- `authorFBID` - The Facebook ID that is used to extract the profile picture.
|
||||
- `title` - The blog post title.
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue