eggy/eifueo
1
1
Fork 1
Code Issues 2 Pull Requests Releases Wiki Activity

doc: Update docs

Browse Source
This commit is contained in:
eggy 2022-05-28 13:20:03 -04:00
parent 57d950cb55
commit 871bed5988
2 changed files with 9 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
CONTRIBUTING.md
View File

@ -39,7 +39,7 @@ Pomme de terre!
Links to images must be either from Kognity or available for free non-commercial use. They should be sent to the site administrator's email to be loaded in as a static local asset. Images should be linked using HTML, have a maximum width of 700 pixels, contain a reference to the source organisation, and fit the overall theme of the site. The link to the image path is `/resources/images/image.file-extension`. If possible, PNGs are preferred. Images should be relevantly named in lowercase with hyphens separating words. Links to images must be either from Kognity or available for free non-commercial use. They should be sent to the site administrator's email to be loaded in as a static local asset. Images should be linked using HTML, have a maximum width of 700 pixels, contain a reference to the source organisation, and fit the overall theme of the site. The link to the image path is `/resources/images/image.file-extension`. If possible, PNGs are preferred. Images should be relevantly named in lowercase with hyphens separating words.
`<img src="/resources/images/velocity-time-graph.png" width=700>(Source: Kognity)</img> `<img src="/resources/images/velocity-time-graph.png" width=700>(Source: Kognity)</img>`
## Special Markdown ## Special Markdown

10
README.md
View File

@ -1,8 +1,8 @@
# Eifueo # Eifueo
A "competitor" of sorts to magicalsoup/highschool. A "competitor" of sorts to magicalsoup/highschool available at https://eifueo.eggworld.tk.
Please see [CONTRIBUTING.md](/eggy/eifueo/src/branch/master/CONTRIBUTING.md) for guidelines and formatting information. Please see [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines and formatting information.
## Dependencies ## Dependencies
@ -18,3 +18,9 @@ MkDocs is used to build the site.
``` ```
mkdocs build mkdocs build
``` ```
For live reload in a development environment:
```
mkdocs serve
```