aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorlonkaars <loek@pipeframe.xyz>2024-04-22 16:53:05 +0200
committerlonkaars <loek@pipeframe.xyz>2024-04-22 16:53:05 +0200
commitacea0828b8638764fa698aae54ba403912354bb8 (patch)
treef2cd7ae5e45977c67eefe74ad09f28bd33d3f857 /docs
parent1e124d005c8b3885ca960a3894019331ef288b5e (diff)
clean up documents
Diffstat (limited to 'docs')
-rw-r--r--docs/.bundle/config2
-rw-r--r--docs/Gemfile2
-rw-r--r--docs/makefile1
-rw-r--r--docs/readme.md6
-rw-r--r--docs/share/meta.adoc10
-rw-r--r--docs/theme.yml49
6 files changed, 54 insertions, 16 deletions
diff --git a/docs/.bundle/config b/docs/.bundle/config
new file mode 100644
index 0000000..92d0e5f
--- /dev/null
+++ b/docs/.bundle/config
@@ -0,0 +1,2 @@
+---
+BUNDLE_PATH: "res/bundle"
diff --git a/docs/Gemfile b/docs/Gemfile
index 99f5ca1..efd0f36 100644
--- a/docs/Gemfile
+++ b/docs/Gemfile
@@ -8,4 +8,6 @@ gem 'asciidoctor-pdf', '~> 2.3'
gem 'asciidoctor-bibtex', '~> 0.8.0'
# gem 'asciidoctor-interdoc-reftext', '~> 0.5.2'
gem 'asciidoctor-interdoc-reftext', git: 'https://github.com/lonkaars/asciidoctor-interdoc-reftext'
+gem 'asciidoctor-lists', '~> 1.0'
+gem 'text-hyphen', '~> 1.5'
diff --git a/docs/makefile b/docs/makefile
index 1fbb5b4..452eddf 100644
--- a/docs/makefile
+++ b/docs/makefile
@@ -15,6 +15,7 @@ ASCIIDOCTOR_ARGS += --require asciidoctor-bibtex
ASCIIDOCTOR_ARGS += --require asciidoctor-pdf
# ASCIIDOCTOR_ARGS += --require ./plugin/helloworld
ASCIIDOCTOR_ARGS += --require asciidoctor-interdoc-reftext
+ASCIIDOCTOR_ARGS += --require asciidoctor-lists
ASCIIDOCTOR_ARGS += --backend pdf
%.pdf: %.adoc $(PDFDEPS)
bundle exec asciidoctor $(ASCIIDOCTOR_ARGS) $<
diff --git a/docs/readme.md b/docs/readme.md
index 2810343..215df50 100644
--- a/docs/readme.md
+++ b/docs/readme.md
@@ -28,10 +28,10 @@ makefile is provided for convenience.
- [x] requirements
- [x] figures
- [x] citations
-- [ ] table of tables
-- [ ] table of figures
+- [x] table of tables
+- [x] table of figures
- [ ] glossary (w/ cross-references)
-- [ ] PDF style
+- [x] PDF style
- [ ] give used requirements more meaningful id's
## for later reference
diff --git a/docs/share/meta.adoc b/docs/share/meta.adoc
index 15d8d18..2e15b79 100644
--- a/docs/share/meta.adoc
+++ b/docs/share/meta.adoc
@@ -29,5 +29,15 @@ endif::[]
// followed by a table of contents
:toc:
+[discrete]
+== List of Figures
+list-of::image[]
+
+[discrete]
+== List of Tables
+list-of::table[]
+
+<<<
+
// also https://docs.asciidoctor.org/asciidoc/latest/attributes/document-attributes-ref
diff --git a/docs/theme.yml b/docs/theme.yml
index 1537f50..5844a86 100644
--- a/docs/theme.yml
+++ b/docs/theme.yml
@@ -9,6 +9,7 @@ page:
base:
hyphens: true
text-align: justify
+ font-size: 10.5
prose:
margin-bottom: 3mm
@@ -17,24 +18,20 @@ prose:
# catalog:
# serif:
# bold: texgyreschola-bold.otf
-# bold_italic: texgyreschola-bolditalic.otf
+# bold-italic: texgyreschola-bolditalic.otf
# italic: texgyreschola-italic.otf
# normal: texgyreschola-regular.otf
-# sans_serif:
+# sans-serif:
# bold: Inter-Bold.otf
-# bold_italic: Inter-BoldItalic.otf
+# bold-italic: Inter-BoldItalic.otf
# italic: Inter-Italic.otf
# normal: Inter-Regular.otf
# monospace:
# bold: JetBrainsMono-Bold.ttf
-# bold_italic: JetBrainsMono-BoldItalic.ttf
+# bold-italic: JetBrainsMono-BoldItalic.ttf
# italic: JetBrainsMono-Italic.ttf
# normal: JetBrainsMono-Regular.ttf
-base:
- # font-family: serif
- font-size: 10.5
-
title-page:
align: center
title:
@@ -65,13 +62,39 @@ caption:
align: center
end: bottom
-example:
- caption:
- end: $caption-end
+image:
+ align: center
+
+list:
+ indent: 10mm
+
+description-list:
+ term-font-style: bold
+
table:
+ align: center
+ border-color: transparent
+ cell-padding: [0.2pt, 2pt]
+ border-color: '#000000'
+ border-width: [ 0.5pt, 0pt, 0.5pt, 0pt ]
+ head:
+ font-style: bold
+ border-bottom-width: 1pt
+ cell:
+ border-width: 0pt
caption:
end: $caption-end
-list:
- indent: 10mm
+footnotes:
+ font-size: round($base-font-size * 0.75)
+
+footer:
+ height: 1in
+ vertical-align: middle
+ recto:
+ center:
+ content: '{page-number}'
+ verso:
+ center:
+ content: '{page-number}'