mirror of
https://github.com/janishutz/libreevent.git
synced 2025-11-25 13:24:24 +00:00
12 lines
1.1 KiB
Markdown
12 lines
1.1 KiB
Markdown
# Website
|
|
The main website's pages are written in HTML & CSS whilst the doc pages are automatically generated by the script in [./build](build/).
|
|
** DO NOT MODIFY THE DOC PAGES IN THE [dist/docs/](dist/docs/) DIRECTORY! **
|
|
|
|
## Links in the md files in [src/](src/)
|
|
Please note that you are required to use either a link relative to the root folder with double forward slash (example: *//server/app.js*), to the website root with a single forward slash (example: */download*) or a full link (example: *https://myevent.janishutz.com/docs*). If you do not follow these patterns, the website won't build or the links will not work correctly. NOTE: Don't be confused if the root folder links don't work in the Markdown, as they use specific syntax for the build script.
|
|
|
|
## Folder structure and file naming
|
|
Please create an *index.md* file inside of a folder such that, when the website is compiled, the *.html* file extension disappears.
|
|
|
|
## Modifying the files in [dist/](dist/)
|
|
You may modify all the files in the [dist/](dist/) directory except the files in [dist/docs/](dist/docs/). |