aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: ac5f02b6814bcfdd94d96b20fea23c2da73a195e (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
39
40
# [hitler.rip](https://hitler.rip)

This is the source code for my website.

Any code (scripts, etc.) is licensed under **AGPLv3-or-later**,
the content is licensed under **CC BY-SA 4.0**.
See `./licenses/` for more information.

- - -

## Build Instructions

The pages on this website are written in Markdown.
Thus we have to convert the Markdown to HTML first using **pandoc**.
This project includes a build script that builds the website.

```sh
./build.sh
```

It also contains a wrapper around the build script that automatically publishes the website when the server is configured using `run.sh` (which yours probably isn't)

```sh
./pub.sh
```

Please note that you should place static content (such as images you link to) in `./dir/`. anything in `./dir/` will get copied without any modification to the `./web/` directory, which will be the root of your web page.

custom directories are not supported yet. you will have to manually edit the build script.

## To-Do

- title share options that link to id
- add a copy button to code blocks

- allow user to create directories

- 404 page
- cgit: styling
- database, php, npm for clicker game