Skip to content

Commit

Permalink
docs(readme): update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ph1p committed Feb 24, 2019
1 parent 7f741a7 commit ffe0d03
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,12 +113,11 @@ You can easily add a custom path to your readme by using the `--readme ./path/to
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 overwritten, set `--rmPattern=./documentation/code/README.md`
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
Simply add:
You can add custom meta data your pages by using the `@vuepress` block:

```javascript
/*
Expand Down Expand Up @@ -151,3 +150,7 @@ yarn dev
# Generate dist folder
yarn build
```

## Contribute

PRs are always welcome (:

0 comments on commit ffe0d03

Please sign in to comment.