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

document that docs/blog-only modes should delete the existing homepage

Browse source
This commit is contained in:
slorber 2020-06-23 18:29:19 +02:00
parent 3c334d781c
commit ce10646606
2 changed files with 12 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

6
website/docs/blog.md
View file

@ -140,6 +140,12 @@ 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 = {
// ...

6
website/docs/docs.md
View file

@ -329,6 +329,12 @@ If you just want the documentation feature, you can enable "docs-only mode".
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`
:::
:::note
More details on functionality of home page for docs can be found in [appropriate section](#home-page-docs).