docs(v2): add documentation for multiple blogs #2933
Conversation
|
Deploy preview for docusaurus-2 ready! Built with commit dc176b2 |
yangshun
added
the
pr: documentation
yangshun
changed the title
website/docs/blog.md
Outdated
| @@ -163,6 +163,25 @@ Make sure there's no `index.js` page in `src/pages` or else there will be two fi | |||
|
|
|||
| ::: | |||
|
|
|||
| ### Multiple blogs | |||
|
|
|||
| You can add another blog by specifying your own blog plugin in the `plugins` option. Set the `routeBasePath` to the URL route that you want your blog to be accessed on. Also, set `path` to the path to your blog folder. | |||
There was a problem hiding this comment.
Recommend using this:
By default, the classic theme assumes only one blog per website and hence includes only one instance of the blog plugin. If you would like to have multiple blogs on a single website, it's possible too! You can add another blog by specifying another blog plugin in the plugins option for docusaurus.config.js. Set the routeBasePath to the URL route that you want your second blog to be accessed on. Note that the routeBasePath here has to be different from the first blog or else there could be a collision of paths! Also, set path to the path to the directory containing your other second blog's entries.
website/docs/blog.md
Outdated
| [ | ||
| '@docusaurus/plugin-content-blog', | ||
| { | ||
| routeBasePath: 'my-blog', // URL route for your blog |
website/docs/blog.md
Outdated
| '@docusaurus/plugin-content-blog', | ||
| { | ||
| routeBasePath: 'my-blog', // URL route for your blog | ||
| path: './my-blog', // path to your blog folder |
website/docs/blog.md
Outdated
| [ | ||
| '@docusaurus/plugin-content-blog', | ||
| { | ||
| routeBasePath: 'my-blog', // URL route for your blog |
There was a problem hiding this comment.
Please use comments similar to https://v2.docusaurus.io/docs/using-plugins#docusaurusplugin-content-blog to better elaborate on the options.
|
I have included your suggested changes, it looks much better now! :D |
Motivation
Add documentation about how to set up multiple blogs.
This PR closes #2481. It also fixes a minor typo.
Have you read the Contributing Guidelines on pull requests?
Yes
Test Plan
The changes can be viewed on Netlify here:
https://deploy-preview-2933--docusaurus-2.netlify.app/docs/blog/#multiple-blogs
Related Information
As noted in #2883, the user needs to add
require.resolve(<plugin-name>)to the plugin name, in addition to the instructions stated in the documentation.But I have excluded this to maintain consistency with the plugins documentation.
Should I make another PR to add in
require.resolvefor all plugin names?