Skip to content

Commit 16a9fe7

Browse files
committed
docs: document eject
1 parent 89538fa commit 16a9fe7

File tree

2 files changed

+10
-0
lines changed

2 files changed

+10
-0
lines changed

docs/default-theme-config/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,8 @@ footer: MIT Licensed | Copyright © 2018-present Evan You
3131

3232
Any additional content after the front matter will be parsed as normal markdown and rendered after the features section.
3333

34+
If you want to use a completely custom homepage layout, you can also use a [Custom Layout](#custom-layout-for-specific-pages).
35+
3436
## Navbar Links
3537

3638
You can add links to the navbar via `themeConfig.nav`:
@@ -223,3 +225,7 @@ layout: SpecialLayout
223225
```
224226

225227
This will render `.vuepress/components/SpecialLayout.vue` for the given page.
228+
229+
## Ejecting
230+
231+
You can copy the default theme source code into `.vuepress/theme` to fully customize the theme using the `vuepress eject [targetDir]` command. Note, however, once you eject, you are on your own and won't be receiving future updates or bug fixes to the default theme even if you upgrade VuePress.

docs/guide/custom-themes.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,3 +79,7 @@ module.exports = {
7979
```
8080

8181
VuePress will attempt to locate and use `node_modules/vuepress-theme-awesome/Layout.vue`.
82+
83+
## Customizing the Default Theme
84+
85+
The `vuepress eject [targetDir]` command will copy the default theme source code into `.vuepress/theme` to allow complete customization. Note, however, once you eject, you are on your own and won't be receiving future updates or bug fixes to the default theme even if you upgrade VuePress.

0 commit comments

Comments
 (0)