Update readme
This commit is contained in:
parent
7581a3b649
commit
ea220efc38
1 changed files with 2 additions and 63 deletions
65
README.md
65
README.md
|
@ -4,69 +4,8 @@ This is the source code for my website: <https://jonathanh.co.uk>.
|
||||||
|
|
||||||
The site is built from markdown using [pandoc](https://pandoc.org/).
|
The site is built from markdown using [pandoc](https://pandoc.org/).
|
||||||
|
|
||||||
## build.sh
|
To build everything, run `make all` which will build the whole site into a
|
||||||
There is a bash script, [build.sh](/jab2870/Website/src/branch/master/build.sh), that creates the necessary files in a `public_html` folder.
|
/public/ folder
|
||||||
|
|
||||||
This can then be hosted on any hosting service.
|
|
||||||
|
|
||||||
The script takes the following commands:
|
|
||||||
|
|
||||||
### Clean
|
|
||||||
|
|
||||||
```bash
|
|
||||||
build.sh clean
|
|
||||||
```
|
|
||||||
|
|
||||||
This will remove the contents of the public_html folder and the tmp folder the script uses to store things like the tag list
|
|
||||||
|
|
||||||
### Tags
|
|
||||||
|
|
||||||
```bash
|
|
||||||
build.sh tags
|
|
||||||
```
|
|
||||||
|
|
||||||
This will build the taglist which is used internally and stored in the `tmp` folder as well as creating archive pages for each tag
|
|
||||||
|
|
||||||
### Blog
|
|
||||||
|
|
||||||
```bash
|
|
||||||
build.sh blog
|
|
||||||
```
|
|
||||||
|
|
||||||
This will build the blog pages for any blogs that have been modified since the last time blogs were built
|
|
||||||
|
|
||||||
### Index
|
|
||||||
|
|
||||||
```bash
|
|
||||||
build.sh index
|
|
||||||
```
|
|
||||||
|
|
||||||
This will generate the homepage.
|
|
||||||
|
|
||||||
### Card
|
|
||||||
|
|
||||||
```bash
|
|
||||||
build.sh card
|
|
||||||
```
|
|
||||||
|
|
||||||
Generates my curlable business card.
|
|
||||||
|
|
||||||
### RSS
|
|
||||||
|
|
||||||
```bash
|
|
||||||
build.sh rss
|
|
||||||
```
|
|
||||||
|
|
||||||
Generates my rss feed.
|
|
||||||
|
|
||||||
|
|
||||||
### All
|
|
||||||
|
|
||||||
```bash
|
|
||||||
build.sh all
|
|
||||||
```
|
|
||||||
|
|
||||||
This will generate the tags, the blogs, the index, the RSS feed and the card.
|
|
||||||
|
|
||||||
## Docker
|
## Docker
|
||||||
|
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue