3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-05-29 08:57:03 +02:00
Code Issues Projects Releases Packages Wiki Activity

docs: elaborate on "docs-only" and "blog-only" (#6131)

Browse source 
* rephrased documentation

* Rewording

Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
This commit is contained in:
Himanshu 2021-12-20 06:59:43 +05:30 • committed by GitHub
parent 638a171673
commit c0a99786b3
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 91 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

20
website/docs/blog.mdx
View file

@ -328,7 +328,7 @@ authors:
The configuration file can be localized, just create a localized copy of it at:
```bash
website/i18n/<locale>/docusaurus-plugin-content-blog/authors.yml
website/i18n/{{locale}}/docusaurus-plugin-content-blog/authors.yml
```
</details>
@ -522,19 +522,21 @@ https://example.com/blog/feed.json
### Blog-only mode {#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.
You can run your Docusaurus 2 site without a dedicated landing page and instead have your blog's post list page as the index page. Set the `routeBasePath` to be `'/'` to serve the blog through the root route `example.com/` instead of the subroute `example.com/blog/`.
```js {10} title="docusaurus.config.js"
```js title="docusaurus.config.js"
module.exports = {
// ...
presets: [
[
'@docusaurus/preset-classic',
{
docs: false,
// highlight-next-line
docs: false, // Optional: disable the docs plugin
blog: {
path: './blog',
routeBasePath: '/', // Set this value to '/'.
// highlight-next-line
routeBasePath: '/', // Serve the blog at the site's root
/* other blog options */
},
},
],
@ -548,6 +550,12 @@ Don't forget to delete the existing homepage at `./src/pages/index.js` or else t
:::
:::tip
There's also a "Docs-only mode" for those who only want to use the docs. Read [Docs-only mode](./guides/docs/docs-introduction.md) for detailed instructions or a more elaborated explanation of `routeBasePath`.
:::
### Multiple blogs {#multiple-blogs}
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`.