From 6a01c64d9358a3457f22785308215ef4c12e6679 Mon Sep 17 00:00:00 2001 From: Syndamia Date: Sat, 19 Feb 2022 16:21:20 +0200 Subject: With folders and hard links shortened overall web links and updated all files with links in them --- README.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index 729b004..c12a347 100644 --- a/README.md +++ b/README.md @@ -11,3 +11,28 @@ The `src` folder contains all of the website files, i.e. the pages, fonts, style `install-ssg6-lowdown.sh` is a shell script that installs both ssg and lowdown. `generate.sh` is a shell script that automatically generates the website into a folder named "website". + +## About index.md files + +In a lot of folder, the `index.md` files are just hard links of other files! For example, `src/about/index.md` is a hard link to `src/about.html`. Why? Because this way, web links are a lot shorter: +``` +Old style link -> New style link + +syndamia.com/about.html -> syndamia.com/about +syndamia.com/tutorials/how-to-use-jira/introduction.html -> syndamia.com/tutorials/how-to-use-jira/ +``` +Of course, the old style links are still available, but the website itself won't be using them during navigation. + +### List of hard links + +In all **multi-page** articles (be it blog article or tutorial or etc.), `introduction.md` is the first page and `index.md` is a hard link to it. Single page articles are just titled `index.md` (it's not a hard link). + +|File at|Hard links to| +|---|---| +|`about/index.md`|`about.md`| +|`blog/index.md`|`blog.md`| +|`contact/index.md`|`contact.md`| +|`courses/index.md`|`courses.md`| +|`tutorials/index.md`|`tutorials.md`| + +*All links are relative to the src folder!* -- cgit v1.3.1-23-gd82d