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

docs(v2): add section for docs-only mode (#2378)

Browse source 
* docs(v2): add section for docs-only mode

* docs(v2): use correct section in document

Co-Authored-By: Alexey Pyltsyn <lex61rus@gmail.com>

Co-authored-by: Alexey Pyltsyn <lex61rus@gmail.com>
This commit is contained in:
Linus Långberg 2020-03-08 14:09:40 +01:00 • committed by GitHub
parent b727723a5c
commit ad3accd3fb
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 27 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

27
website/docs/configuration.md
View file

@ -147,3 +147,30 @@ const Hello = () => {
If you just want to use those fields on the client side, you could create your own JS files and import them as ES6 modules, there is no need to put them in `docusaurus.config.js`.
:::
## Docs-only mode
You can run your Docusaurus 2 site without a landing page and instead have a page from your documentation as the index page.
Set the `routeBasePath` to indicate that it’s the root path.
**Note**: Make sure there’s no `index.js` page in `src/pages` or there will be two files mapped to the same route!
```js {9}
// docusaurus.config.js
module.exports = {
// ...
presets: [
[
'@docusaurus/preset-classic',
{
docs: {
routeBasePath: '/' // Set this value to '/'.
},
},
],
],
};
```
You can apply the same principle for blogs with the [Blog-only mode](blog.md#blog-only-mode).