expanded readme

This commit is contained in:
julius zeidler 2022-08-08 18:38:01 +02:00
parent c2cacc5ab4
commit b4ba94a839

View file

@ -7,4 +7,14 @@ Install Nodejs Version 14.
Run `yarn install` to install the required packages.
Run `yarn dev` to start the local development environment.
Push to `main` branch to deploy the website.
Push to `main` branch to deploy the website.
## Editing
Vuepress uses Markdown. Documentation on how to use it, is readily avaible.
You can use Frontmatter to change layout and other settings per page: [https://v2.vuepress.vuejs.org/reference/default-theme/frontmatter.html](https://v2.vuepress.vuejs.org/reference/default-theme/frontmatter.html)
Inside the `docs` folder, you'll find several files and folders.
The file `docs/blog/helloworld.md` will be rendered to `/blog/helloworld`, the `docs/blog/readme.md` will be rendered to `/blog/`
Images and other assets can be placed into the public dir. `docs/.vuepress/public/images/example.png` and be accessed in the browser via `/images/example.png`.