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

docs(v2): correct the documentation for doc-only mode (#3040)

Browse source
This commit is contained in:
Teik Jun 2020-07-09 23:15:23 +08:00 • committed by GitHub
parent 04fc4190f9
commit 11751c20b0
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 22 additions and 22 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
website/docs/blog.md
View file

@ -140,12 +140,6 @@ https://{your-domain}/blog/atom.xml
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.
:::caution
Don't forget to delete the existing homepage at `./src/pages/index.js`
:::
```js {9} title="docusaurus.config.js"
module.exports = {
// ...
@ -163,9 +157,9 @@ module.exports = {
};
```
:::note
:::caution
Make sure there's no `index.js` page in `src/pages` or else there will be two files mapping to the same route!
Don't forget to delete the existing homepage at `./src/pages/index.js` or else there will be two files mapping to the same route!
:::

20
website/docs/docs.md
View file

@ -325,15 +325,9 @@ module.exports = {
## Docs-only mode
If you just want the documentation feature, you can enable "docs-only mode".
If you only want the documentation feature, you can run your Docusaurus 2 site without a landing page and display your documentation page as the index page instead.
To achieve this, set the `routeBasePath` property of the `docs` object in `@docusaurus/preset-classic` in `docusaurus.config.js` to the root of your site, and also in that object set the `homePageId` property with the value of the document ID that you show as root of the docs.
:::caution
Don't forget to delete the existing homepage at `./src/pages/index.js`
:::
To enable docs-only mode, set the `routeBasePath` property of the `docs` object to the root of your site. Also, set the `homePageId` property to the ID of the document that you wish to show by default.
:::note
@ -362,8 +356,14 @@ module.exports = {
Now, when visiting your site, it will show your initial document instead of a landing page.
:::tip
:::caution
There's also a "blog-only mode", for those who only want to use the blog component of Docusaurus 2. You can use the same method detailed above, except that you need to delete the `/src/pages/index.js` file. Follow the setup instructions on [Blog-only mode](blog.md#blog-only-mode).
You should delete the existing homepage at `./src/pages/index.js`, or else there will be two files mapping to the same route!
:::
:::tip
There's also a "blog-only mode" for those who only want to use the blog feature of Docusaurus 2. You can use the same method detailed above. Follow the setup instructions on [Blog-only mode](blog.md#blog-only-mode).
:::

14
website/versioned_docs/version-2.0.0-alpha.58/docs.md
View file

@ -325,9 +325,9 @@ module.exports = {
## Docs-only mode
If you just want the documentation feature, you can enable "docs-only mode".
If you only want the documentation feature, you can run your Docusaurus 2 site without a landing page and display your documentation page as the index page instead.
To achieve this, set the `routeBasePath` property of the `docs` object in `@docusaurus/preset-classic` in `docusaurus.config.js` to the root of your site, and also in that object set the `homePageId` property with the value of the document ID that you show as root of the docs.
To enable docs-only mode, set the `routeBasePath` property of the `docs` object to the root of your site. Also, set the `homePageId` property to the ID of the document that you wish to show by default.
:::note
@ -356,8 +356,14 @@ module.exports = {
Now, when visiting your site, it will show your initial document instead of a landing page.
:::tip
:::caution
There's also a "blog-only mode", for those who only want to use the blog component of Docusaurus 2. You can use the same method detailed above, except that you need to delete the `/src/pages/index.js` file. Follow the setup instructions on [Blog-only mode](blog.md#blog-only-mode).
You should delete the existing homepage at `./src/pages/index.js`, or else there will be two files mapping to the same route!
:::
:::tip
There's also a "blog-only mode" for those who only want to use the blog feature of Docusaurus 2. You can use the same method detailed above. Follow the setup instructions on [Blog-only mode](blog.md#blog-only-mode).
:::