Skip to content

Commit 505238d

Browse files
committed
Update README
1 parent 62812c2 commit 505238d

1 file changed

Lines changed: 52 additions & 5 deletions

File tree

README.md

Lines changed: 52 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,56 @@
11
Example Website With httk.web
22
-----------------------------
33

4-
This repository is a simple example of how to set up a website with a blog using
5-
``httk.web`` from ``httk-web``.
4+
This repository is a simple starter for building a semi-static website with a
5+
blog using ``httk.web`` from ``httk-web``.
66

7-
Fork this repository, edit the content under ``src/content``, and if you keep it
8-
on GitHub, enable GitHub Pages using GitHub Actions. The workflow in
9-
``.github/workflows/httkweb.yaml`` generates and publishes the website.
7+
Quick start
8+
-----------
9+
10+
```bash
11+
python -m pip install -e .
12+
make serve
13+
```
14+
15+
Then open:
16+
17+
- http://127.0.0.1:8080/
18+
19+
Edit content
20+
------------
21+
22+
Main pages are in ``src/content`` and blog posts are in
23+
``src/content/blogposts``.
24+
25+
Small example: update the homepage title in ``src/content/index.md``:
26+
27+
```yaml
28+
---
29+
title: My Website
30+
name: Main
31+
template: default
32+
base_template: base_default
33+
---
34+
```
35+
36+
Then regenerate static output:
37+
38+
```bash
39+
make generate
40+
```
41+
42+
This writes files to ``public/``.
43+
44+
GitHub Pages
45+
------------
46+
47+
If this repository is hosted on GitHub, enable GitHub Pages with GitHub Actions.
48+
The workflow in ``.github/workflows/httkweb.yaml`` builds and publishes the
49+
site on pushes to ``main``.
50+
51+
More information
52+
----------------
53+
54+
For full documentation, see:
55+
56+
- https://docs2.httk.org/httk-web/

0 commit comments

Comments
 (0)