draussenfunker-public/draussenfunker.github.io
1
0
Fork 0
mirror of https://github.com/draussenfunker/draussenfunker.github.io.git synced 2025-12-31 08:29:17 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

[FEATURE] Add contribution instructions to readme.md

Browse source
This commit is contained in:
Nikolas Hagelstein 2023-07-28 21:33:23 +02:00
parent c634db70f4
commit 8b0855d884
1 changed files with 19 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

20
README.md
View file

@ -17,4 +17,22 @@ You can use Frontmatter to change layout and other settings per page: [https://v
Inside the `docs` folder, you'll find several files and folders. 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/` 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`. 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`.
## Contribution
Piece of cake:
- File an issue
- File a corresponding pull request
- "I don't know what a pull request is!" : Just file an issue, we ll take good care of you. :)
### Setting up a Development Environment to contribute
#### Methode #1
tl;dr:
- clone the repository
- run "yarn install"
- run "yarn dev"
#### Methode #2
You got a docker environment running anyway? Lovely:
- run docker compose up