blob: c12a34736b1a0d1e5c5268b429c051003fb6b8ee (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
|
# syndamiadotcom
Repository for my website.
The pages of the website are (mostly) written in Markdown. Using [ssg](https://www.romanzolotarev.com/ssg.html) and [lowdown](https://kristaps.bsd.lv/lowdown/) they are generated into a **static** website.
## Contents of this repository
The `src` folder contains all of the website files, i.e. the pages, fonts, styles, images, etc.
`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!*
|
