summaryrefslogtreecommitdiffstats
path: root/README.md
blob: 93a72a4260e6dc37620423044d303d3685192b56 (plain)
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
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
% WTF is Linux website

This contains the source code of the WTF is Linux support website.

Compilation
-----------

These programs are needed to compile this website into HTML format:

- make
- [Pandoc](https://pandoc.org/)
- [pandoc-sidenote](https://github.com/jez/pandoc-sidenote/)

To compile it, simply run:

```sh
make
```

If you can't install the `pandoc-sidenote` project, simply remove this line
from the Makefile:

```
--filter pandoc-sidenote \
```

Acknowledgements
----------------

These resources helped me create and design this website:

[Pandoc](https://pandoc.org/)

: Converts the Markdown into HTML and potentially other formats

[pandoc-sidenote](https://github.com/jez/pandoc-sidenote/)

: A Pandoc filter that generates the HTML for sidenotes

[tufte-css](https://edwardtufte.github.io/tufte-css/)

: A stylesheet for web articles (contains the CSS for sidenotes)

[latex-css](https://latex.now.sh/)

: A stylesheet for the LaTeX feel on the web

[et-book](https://edwardtufte.github.io/et-book/)

: The fonts used in this website, and in Tufte CSS

[Nord theme](https://www.nordtheme.com/)

: The color palette used in this website