janishutz/libreevent
1
0
Fork 0
mirror of https://github.com/janishutz/libreevent.git synced 2025-11-25 13:24:24 +00:00
Code Issues Packages Projects Releases Wiki Activity

restructuring

Browse Source
This commit is contained in:
janis
2023-03-06 16:31:53 +01:00
parent ffc66602b3
commit d1e733e88e
25 changed files with 35 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
website/README.md Normal file
View File

@@ -0,0 +1,12 @@
# 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/).