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

docs(v2): misc update

Browse source
This commit is contained in:
Yangshun Tay 2019-10-12 14:28:21 -07:00
parent 37bccf5668
commit 1d968be5bb
4 changed files with 54 additions and 39 deletions
Download patch file Download diff file Expand all files Collapse all files

22
website/docs/blog.md
View file

@ -11,9 +11,9 @@ Then, add a navbar link to your blog within `docusaurus.config.js`:
```js
links: [
...
{to: 'blog', label: 'Blog', position: 'left'}, // or position: 'right'
...
...
{to: 'blog', label: 'Blog', position: 'left'}, // or position: 'right'
...
]
```
@ -23,7 +23,7 @@ To publish in the blog, create a file within the blog directory with a formatted
For example, at `my-website/blog/2019-09-05-hello-docusaurus-v2.md`:
```yml
```md
---
title: Welcome Docusaurus v2
author: Dattatreya Tripathy
@ -33,8 +33,7 @@ authorTwitter: CuriousDT
tags: [hello, docusaurus-v2]
---
Welcome to this blog. This blog is created with [**Docusaurus 2 alpha**]
(https://v2.docusaurus.io/).
Welcome to this blog. This blog is created with [**Docusaurus 2 alpha**](https://v2.docusaurus.io/).
<!--truncate-->
@ -57,7 +56,7 @@ The only required field is `title`; however, we provide options to add author in
Use the `<!--truncate-->` marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. Anything above `<!--truncate-->` will be part of the summary. For example:
```yml
```md
---
title: Truncation Example
---
@ -79,9 +78,11 @@ Or this.
### Blog-only mode
You can run your Docusaurus 2 site without a landing page and instead have your blog's post list page as the index page. Set the `routeBasePath` to be `'/'` to indicate it's the root path. Make sure there's no `index.js` page in `src/pages` or else there could be a conflict of paths!
You can run your Docusaurus 2 site without a landing page and instead have your blog's post list page as the index page. Set the `routeBasePath` to be `'/'` to indicate it's the root path.
```diff
**Note:** Make sure there's no `index.js` page in `src/pages` or else there will be two files mapping to the same route!
```js
// docusaurus.config.js
module.exports = {
// ...
@ -91,7 +92,7 @@ module.exports = {
{
blog: {
path: './blog',
+ routeBasePath: '/',
routeBasePath: '/', // Set this value to '/'.
},
},
],
@ -99,7 +100,6 @@ module.exports = {
};
```
<!--
Adding a blog using the blog plugin.