From b4ba94a8390f5a0ba1c143fc3e3b526e53452d2d Mon Sep 17 00:00:00 2001 From: julius zeidler Date: Mon, 8 Aug 2022 18:38:01 +0200 Subject: [PATCH] expanded readme --- README.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 27662c3a..cabd24a0 100644 --- a/README.md +++ b/README.md @@ -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. \ No newline at end of file +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`. \ No newline at end of file