Skip to content

Commit cfb3eb8

Browse files
committed
Add instructions, move CSS out of Markdown file
Styling and metadata would just render as plain text on github.com - a slightly longer pandoc invocation is a better tradeoff.
1 parent 36021af commit cfb3eb8

2 files changed

Lines changed: 33 additions & 6 deletions

File tree

README.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,38 @@
11
# Python New Zealand - Rules
22

3+
Official rules of [Python New Zealand](https://python.nz).<br>
4+
This repository holds the authoritative source code of the documents and tracks changes to them.
5+
36
* Constitution
47
* Bylaws
58
* Code of Conduct
9+
10+
## How to create documents
11+
12+
### Constitution
13+
14+
This is Markdown source code to produce HTML (for https://python.nz) and PDF (for printing)<br>
15+
*Note: On github.com, bullet points will show in addition to numbering (styling is ignored)*
16+
17+
#### Create HTML
18+
19+
Use [pandoc](https://pandoc.org):
20+
```
21+
pandoc -s constitution.md -o constitution.html -c constitution.css -V "pagetitle:Constitution"
22+
```
23+
(`-s` standalone = embed external CSS, `pagetitle` to suppress title warning without inserting another headline)
24+
25+
#### Table of Contents
26+
27+
Optionally, `--toc` will also create a table of contents with headline links (handy but not fit for PDF)
28+
```
29+
pandoc -s constitution.md -o constitution.html -c constitution.css -V "pagetitle:Constitution" --toc
30+
```
31+
32+
#### Create PDF
33+
34+
Use [weasyprint](https://weasyprint.org) or similar, or just print from your browser:
35+
```
36+
weasyprint constitution.html constitution.pdf
37+
```
38+

constitution.md

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,3 @@
1-
<style>
2-
ul {
3-
list-style: none;
4-
}
5-
</style>
6-
71
# **Constitution**
82

93
## **Introductory rules**

0 commit comments

Comments
 (0)