Files
libreevent/website
2024-06-05 14:06:17 +02:00
..
2024-06-05 14:06:17 +02:00
2024-06-05 14:06:17 +02:00
2024-05-24 09:50:23 +02:00
2023-06-17 12:41:17 +02:00

Website

The main website's pages are written in HTML & CSS whilst the doc pages are automatically generated by the script in ./build. ** DO NOT MODIFY THE DOC PAGES IN THE dist/docs/ DIRECTORY! **

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), to the docs root with &/ (example: &/setup) or simply /docs/ (example: /docs/setup), a full link (example: https://libreevent.janishutz.com/docs) or a relative link (example: plugins/music). Note that ../ relative links are NOT intended to be used and will lead to an error when building the 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, file naming and file structure

Please note that the filename that is used for the md file is used to create a folder that contains an index.html so the .html file extension disappears. The build script uses the first level 1 title (marked with # in md) as the page title and also for the navigation menu, so please choose the title appropriately and don't let it exceed 50 characters!

Modifying the files in dist/

You may modify all the files in the dist/ directory except the files in dist/docs/.