summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLars Wirzenius <liw@sequoia-pgp.org>2021-10-29 18:35:27 +0300
committerLars Wirzenius <liw@sequoia-pgp.org>2021-10-29 18:35:27 +0300
commitf18473f0ccba287e768490ef26eeb0a859a62cec (patch)
tree74caffa816ac921d331e1be0d03f605afabafad8
parent90b6bac5dd84ec7714967a5913a7cb5a3fc72004 (diff)
downloadsq-user-guide-f18473f0ccba287e768490ef26eeb0a859a62cec.tar.gz
tweak formatting
Use Pandoc directly, and do some trivial styling of the HTML.
-rw-r--r--Makefile9
-rw-r--r--sq-guide.md14
-rw-r--r--sq.css61
3 files changed, 75 insertions, 9 deletions
diff --git a/Makefile b/Makefile
index fb14046..93931ed 100644
--- a/Makefile
+++ b/Makefile
@@ -1,9 +1,14 @@
+PANDOCOPTS = --standalone --number-sections --toc
+HTMLOPTS = -H sq.css
+
.SUFFIXES: .md .html .pdf
.md.html:
- subplot docgen $< --output $@
+ pandoc $(PANDOCOPTS) $(HTMLOPTS) --output $@ $<
.md.pdf:
- subplot docgen $< --output $@
+ pandoc $(PANDOCOPTS) --output $@ $<
all: sq-guide.html sq-guide.pdf
+
+sq-guide.html: sq-guide.md sq.css Makefile
diff --git a/sq-guide.md b/sq-guide.md
index 4fa3222..a1c9916 100644
--- a/sq-guide.md
+++ b/sq-guide.md
@@ -5,7 +5,7 @@ author: "The Sequoia-PGP project"
documentclass: report
...
-# Prelude: quick start
+# Prelude: quick start {.unnumbered}
If you're in a hurry to get started, this chapter is for you. This
chapter is a distillation of the main content of this guide into
@@ -155,8 +155,8 @@ gratefully accept changes for additional target systems.
On a Debian system (version 11 or later):
-```sh
-$ apt install sq
+```
+apt install sq
```
Note that on Debian 11 (bullseye), the version of `sq` is rather old.
@@ -717,7 +717,7 @@ keys.openpgp.org and WKD.
## Revoking keys
-# Appendix: How to...?
+# Appendix: How to...? {.unnumbered}
This appendix has task oriented guides for achieving specific goals.
Each how-to guide will explain every step, giving command line
@@ -737,7 +737,7 @@ specifics that have been covered in the rest of the book.
-# Appendix: Switching from GnuPG to Sequoia-PGP
+# Appendix: Switching from GnuPG to Sequoia-PGP {.unnumbered}
This appendix is aimed at people who already know how to use `gpg`,
the command line tool from GnuPG that roughly corresponds to `sq`. It
@@ -862,7 +862,7 @@ that GnuPG may output the cleartext, even if the signature fails.
gpg --decrypt hello.txt.gpg
```
-# Appendix: Glossary {#glossary}
+# Appendix: Glossary {#glossary .unnumbered}
This appendix explains all the specialist terminology related to
OpenPGP and Sequoia-PGP. It includes both the terms Sequoia prefers
@@ -943,7 +943,7 @@ verify
-# Appendix: References {#references}
+# Appendix: References {#references .unnumbered}
* [OpenPGP on Wikipedia](https://en.wikipedia.org/wiki/Pretty_Good_Privacy#OpenPGP)
* [PGP on Wikipedia](https://en.wikipedia.org/wiki/Pretty_Good_Privacy)
diff --git a/sq.css b/sq.css
new file mode 100644
index 0000000..c001036
--- /dev/null
+++ b/sq.css
@@ -0,0 +1,61 @@
+<style>
+html {
+ background: white;
+ font-family: serif;
+ margin-left: 3em;
+ margin-right: 2em;
+ margin-top: 2em;
+}
+
+body {
+ max-width: 50em;
+ line-height: 150%;
+}
+
+.sourceCode {
+ max-width: unset;
+}
+
+nav {
+ line-height: 100%;
+}
+
+h1, h2, h3, h4, h5, h6 {
+ font-family: sans-serif;
+ font-weight: bold;
+ margin-top: 2em;
+}
+
+h1 {
+ font-size: 150%;
+}
+
+h2 {
+ font-size: 120%;
+}
+
+h3 {
+ font-size: 100%;
+}
+
+ul li, ol li {
+ margin-top: 0.5em;
+ margin-bottom: 0.5em;
+}
+
+table {
+ border: 0px;
+ width: 100%;
+}
+
+th {
+ font-weight: bold;
+}
+
+tr {
+}
+
+tr:nth-child(even) {
+ background-color: #f2f2f2;
+}
+</style>