website

Sources for my personal website
git clone https://git.svemoe.de/website.git
Log | Files | Refs | README

README.md (1209B)

      1 # Sources for my personal website
      2 <https://svenmoeller.xyz>
      3 
      4 * [Local Mirror](https://git.svenmoeller.xyz/website/)
      5 * [GitHub Mirror](https://github.com/svemoe/website)
      6 * [GitLab Mirror](https://gitlab.com/svemoe/website)
      7 
      8 ## Prerequisites
      9 
     10 - [Pandoc](https://pandoc.org/)
     11 - [GNU make](https://www.gnu.org/software/make/)
     12 - `rsync`
     13 
     14 ## Build instructions
     15 
     16     make
     17 
     18 Will build the website to the target directory.
     19 Standard is `./dst/`, can be changed with `DST_DIR`.
     20 
     21     make clean
     22 
     23 Removes the target directory.
     24 
     25 ## Source files
     26 
     27 The pages are written in `markdown` format.
     28 The level 1 heading will be used as title of the page.
     29 Links with the extension `.md` will be changed to `.html`.
     30 
     31 The `template.html` gets used by `pandoc` to convert the pages to `html`.
     32 
     33 The contents of the `static` folder are copied to the target directory verbatim.
     34 
     35 The `Makefile` contains the recipe for building the website from source.
     36 
     37 ## Deployment
     38 
     39 I have a `git post-receive` hook that checks out the work tree to a directory on the server.
     40 
     41 The hook then runs `make` inside this directory.
     42 `DST_DIR` points to the place from where I serve the page with `nginx`.
     43 
     44 ### See also 
     45 
     46 - <https://toroid.org/git-website-howto>