Skip to content

Commit 0daf0a6

Browse files
committed
Move document creation instructions to constitution
1 parent 58c602a commit 0daf0a6

File tree

2 files changed

+32
-35
lines changed

2 files changed

+32
-35
lines changed

README.md

Lines changed: 0 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -9,38 +9,3 @@ authoritative source code of the documents and tracks changes to them.
99

1010
If you have any questions or concerns about our rules please contact
1111
[committee@python.nz](mailto:committee@python.nz).
12-
13-
## How to create documents
14-
15-
### Constitution
16-
17-
This is Markdown source code to produce HTML (for https://python.nz) and PDF (for
18-
printing).<br> _Note: On github.com, bullet points will show in addition to numbering
19-
(styling is ignored). Also, empty HTML comments have been inserted to prevent wrong
20-
indentation following unordered lists. The HTML/PDF results look fine._
21-
22-
#### Create HTML
23-
24-
Use [pandoc](https://pandoc.org):
25-
26-
```
27-
pandoc -s constitution.md -o constitution.html -c constitution.css -V "pagetitle:Constitution"
28-
```
29-
30-
(`-s` standalone = embed external CSS, `pagetitle` to suppress title warning without
31-
inserting another headline)
32-
33-
#### Table of Contents
34-
35-
Optionally, `--toc` will also create a table of contents with headline links (handy but
36-
not fit for PDF):
37-
38-
```
39-
pandoc -s constitution.md -o constitution.html -c constitution.css -V "pagetitle:Constitution" --toc
40-
```
41-
42-
#### Create PDF
43-
44-
Just print the HTML from your browser to a PDF file.<br> If you want to use a dedicated
45-
conversion tool instead, check that it does the job correctly (the numbering of bullets
46-
and sub bullets is where [weasyprint](https://weasyprint.org/) failed)

constitution/README.txt

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Constitution
2+
3+
This is Markdown source code to produce HTML (for https://python.nz) and PDF (for
4+
printing).<br> _Note: On github.com, bullet points will show in addition to numbering
5+
(styling is ignored). Also, empty HTML comments have been inserted to prevent wrong
6+
indentation following unordered lists. The HTML/PDF results look fine._
7+
8+
#### Create HTML
9+
10+
Use [pandoc](https://pandoc.org):
11+
12+
```
13+
pandoc -s constitution.md -o constitution.html -c constitution.css -V "pagetitle:Constitution"
14+
```
15+
16+
(`-s` standalone = embed external CSS, `pagetitle` to suppress title warning without
17+
inserting another headline)
18+
19+
#### Table of Contents
20+
21+
Optionally, `--toc` will also create a table of contents with headline links (handy but
22+
not fit for PDF):
23+
24+
```
25+
pandoc -s constitution.md -o constitution.html -c constitution.css -V "pagetitle:Constitution" --toc
26+
```
27+
28+
#### Create PDF
29+
30+
Just print the HTML from your browser to a PDF file.<br> If you want to use a dedicated
31+
conversion tool instead, check that it does the job correctly (the numbering of bullets
32+
and sub bullets is where [weasyprint](https://weasyprint.org/) failed)

0 commit comments

Comments
 (0)