Skip to content

Commit

Permalink
docs(readme): update explanation about readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ph1p committed Sep 3, 2021
1 parent 1e4f344 commit 5340d78
Showing 1 changed file with 0 additions and 3 deletions.
3 changes: 0 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -139,9 +139,6 @@ module.exports = {
You can easily add a custom path to your readme by using the `--readme ./path/to/file.md` parameter. If you move a `README.md` inside your source folder, it should resolve it automatically.
You can set the title by passing it to the `sidebarTree('Mainpage title')` function inside your `./.vuepress/config.js`.

Once the README.md has been added, it is no longer overwritten!
If you want it to be overwritten, set `--rmPattern=./documentation/code/README.md`.

## @vuepress comment block

You can add custom meta data to your pages by using the `@vuepress` block:
Expand Down

0 comments on commit 5340d78

Please sign in to comment.