Skip to content

Commit

Permalink
docs(v2): add section for docs-only mode (#2378)
Browse files Browse the repository at this point in the history
* 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>
  • Loading branch information
phoqe and lex111 authored Mar 8, 2020
1 parent b727723 commit ad3accd
Showing 1 changed file with 27 additions and 0 deletions.
27 changes: 27 additions & 0 deletions website/docs/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).

0 comments on commit ad3accd

Please sign in to comment.