Skip to content

Commit

Permalink
docs: update migration page
Browse files Browse the repository at this point in the history
  • Loading branch information
benjamincanac committed Feb 16, 2021
1 parent bb46c29 commit 696d5a8
Showing 1 changed file with 41 additions and 1 deletion.
42 changes: 41 additions & 1 deletion docs/content/en/03.more/04.migration.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,10 @@ By migrating to docus, you will have a fresh new design for your documentation
</div>
</div>

## Steps

### `package.json`

In order to move from `@nuxt/content-theme-docs` to `docus` you need to install the new package:

<code-group>
Expand All @@ -41,6 +45,8 @@ npm uninstall @nuxt/content-theme-docs && npm install docus
</code-block>
</code-group>

### `nuxt.config.js`

Then, instead of importing `@nuxt/content-theme-docs`, you need to import `docus` in your `nuxt.config.js`:

<code-group>
Expand Down Expand Up @@ -101,4 +107,38 @@ export default theme({
</code-block>
</code-group>

You can now redeploy your application to take advantage of `docus` and its new features!
### `content/settings.json`

If you specified `githubApi`, `defaultBranch` or `defaultDir` in `content/settings.json`, you need to change those keys following the [Configuration](/usage/configuration) documentation.

The `github` key can now be a `String` to act as `github.repo` or an object with `repo`, `branch`, `dir`, `url` and `apiUrl` keys:

<code-group>
<code-block label="New" active>

```json
{
"github": {
"repo": "nuxtlabs/docus",
"branch": "main",
"dir": "docs"
}
}
```

</code-block>
<code-block label="Old">

```json
{
"github": "nuxtlabs/docus",
"defaultBranch": "main",
"defaultDir": "docs"
}
```

</code-block>
</code-group>


🎉 Congrats, you can now redeploy your application to take advantage of `docus` and its new features!

1 comment on commit 696d5a8

@vercel
Copy link

@vercel vercel bot commented on 696d5a8 Feb 16, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.