mirror of
https://github.com/facebook/docusaurus.git
synced 2025-07-29 14:38:50 +02:00
Basic blog guide (#59)
This commit is contained in:
parent
43ef3c8142
commit
aa014b2109
2 changed files with 44 additions and 0 deletions
43
docs/guides-blog.md
Normal file
43
docs/guides-blog.md
Normal file
|
@ -0,0 +1,43 @@
|
|||
---
|
||||
id: blog
|
||||
title: Adding a Blog
|
||||
---
|
||||
|
||||
## Initial Setup
|
||||
|
||||
To setup your site's blog, start by creating a `blog` folder within your repo's `website` directory.
|
||||
|
||||
Then, add a header link to your blog within `siteConfig.js`:
|
||||
|
||||
```
|
||||
headerLinks: [
|
||||
...
|
||||
{href: '/blog', label: 'Blog'},
|
||||
...
|
||||
]
|
||||
```
|
||||
|
||||
## Adding blog 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`:
|
||||
|
||||
```
|
||||
---
|
||||
author: Frank Li
|
||||
authorURL: https://twitter.com/foobarbaz
|
||||
authorFBID: 503283835
|
||||
title: Introducing Docusaurus
|
||||
---
|
||||
|
||||
Lorem Ipusm..
|
||||
```
|
||||
|
||||
## Special blog post header options
|
||||
|
||||
- `author` - The text label of the author byline
|
||||
- `authorURL` - The url that the author name links to
|
||||
- `authorFBID` - The Facebook ID that is used to extract the profile picture
|
||||
- `title` - The blog post title
|
|
@ -7,6 +7,7 @@
|
|||
],
|
||||
"Guides": [
|
||||
"navigation",
|
||||
"blog",
|
||||
"translation",
|
||||
"search",
|
||||
"versioning"
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue