update doc structure and fix inline code stylinng

svbaelen · May 28, 2024 · e5c6f6c · e5c6f6c
1 parent 29e2b29
commit e5c6f6c
Show file tree

Hide file tree

Showing 15 changed files with 514 additions and 20 deletions.
diff --git a/config/config.yaml b/config/config.yaml
@@ -30,7 +30,7 @@ input-files:
   - ./src/02_chapter_1.md
   - ./src/03_conclusion.md
   - ./src/04_acknowledgment.md
-  - ./src/05_references.md
+  - ./src/bibliography/references.md
   #- ./src/appendix.md # add this per outpuf file (see ./<format>/config.yaml)
 
 # -------------------------------------------------------------------------

diff --git a/config/html/config.yaml b/config/html/config.yaml
@@ -9,7 +9,7 @@
 
 # add some input files
 input-files:
-  - ./src/appendix.md
+  - ./src/appendix/appendix.md
 
 # styling
 css:

diff --git a/config/html/css/main.css b/config/html/css/main.css
@@ -431,6 +431,7 @@ code {
 }
 
 a > code,
+li > code,
 p > code {
     padding:0.25em;
     background-color: var(--color-background-code-inline);

diff --git a/config/pdf/config.yaml b/config/pdf/config.yaml
@@ -8,7 +8,7 @@
 
 # add some input files
 input-files:
-  - ./src/appendix.md
+  - ./src/appendix/appendix.md
 
 log-file: build/pdf.log
 output-file: build/index.pdf

diff --git a/config/tex/config.yaml b/config/tex/config.yaml
@@ -8,7 +8,7 @@
 #
 # add some input files
 input-files:
-  - ./src/appendix.md
+  - ./src/appendix/appendix.md
 
 log-file: build/tex.log
 output-file: build/index.tex

diff --git a/src/01_intro.md b/src/01_intro.md
@@ -56,8 +56,9 @@ All human beings are born free and equal in dignity and rights. All human beings
 
 ## Mixed lists
 
-- All human beings are born free and equal in dignity and rights.
-    1. All human beings are born free and equal in dignity and rights.
+- All human beings are born free and equal in `dignity and rights`.
+    1. All human beings are born free and equal in `dignity and rights`.
+        - All human beings are born free and equal in `dignity and rights`.
     2. All human beings are born free and equal in dignity and rights.
 - All human beings are born free and equal in dignity and rights.
 
@@ -206,6 +207,8 @@ All human beings are born free and equal in dignity and rights. All human beings
 
 ## Scientific citations
 
+Syntax: `[@<ref-in-bibfile>`].
+
 > All human beings are born free and equal in dignity and rights. They are endowed with reason and conscience and should act towards one another in a
 > spirit of brotherhood [@unitednations1948].
 

diff --git a/src/_base.md b/src/_base.md
@@ -10,6 +10,10 @@
 #   - <http://lierdakil.github.io/pandoc-crossref/#settings-file>
 #==============================================================
 
+# ----------
+# Main
+# ----------
+
 author:
   - Senne Van Baelen
   - "[Pandoc Contributors](https://github.com/jgm/pandoc/graphs/contributors)"
@@ -19,24 +23,46 @@ title: '[cowkit](https://github.com/svbaelen/cowkit)'
 subtitle: 'A Comfortable Open Writing Kit<br> (example document)'
 toc-title: 'Contents'
 
-bibliography_main: ./src/references.bib
-bibliography_sources: ./src/sources.bib
-#csl: https://www.zotero.org/styles/chicago-note-bibliography
-csl: https://www.zotero.org/styles/ieee
-
-endnote: false
 keywords:
   - cowkit
   - academic writing
-
+endnote: false
 lang: en_GB
+
+# HTML-only
+author-meta:
+  - Senne Van Baelen
+date-meta: 2024
+
+
+# ----------
+# Citations
+# ----------
+bibliography_main: ./src/bibliography/references.bib
+<!--bibliography_sources: ./src/bibliography/sources.bib-->
+<!-- Link your style: <https://www.zotero.org/styles> (not possibly local!) -->
+#csl: https://www.zotero.org/styles/chicago-note-bibliography
+<!-- DOWNLOAD your style: <https://www.zotero.org/styles> -->
+csl: ./src/bibliography/ieee.csl
 link-citations: true
 link-bibliography: true
+
 suppress-bibliography: false
+
+# nocite (best not combined with numeric IEEE citation styles; it messes with the order)
+#nocite: |
+#  @brown2016
+
+# ----------
+# Listings
+# ----------
 listings: true                   # needed together with listings: true in yaml config
                                  # (for default pandoc crossref listing style, simply
                                  #  set both to false)
 
+# ----------
+# Prefixes
+# ----------
 # http://lierdakil.github.io/pandoc-crossref/#reference-format
 eqnPrefix: Eq.
 figPrefix: Fig.
@@ -63,14 +89,10 @@ header-includes:
   - <script src="./scripts/scroll.js"></script>
   - \definecolor{myhrefcolor}{HTML}{0645AD}
 
-# HTML
-# ======
-
-author-meta:
-  - Senne Van Baelen
-date-meta: 2024
 
-# options
+# --------------
+# Custom options
+# --------------
 code-lang: true  # show code language in code blocks
 code-copy: true  # add copy-to-clipboard button in code blocks
 # Download other outputs: requires a .pdf/.tex with this name in your server directory

diff --git a/src/appendix.md → src/appendix/appendix.md b/src/appendix.md → src/appendix/appendix.md
diff --git a/src/list_of_figures.md → src/appendix/list_of_figures.md b/src/list_of_figures.md → src/appendix/list_of_figures.md
diff --git a/src/list_of_listings.md → src/appendix/list_of_listings.md b/src/list_of_listings.md → src/appendix/list_of_listings.md
diff --git a/src/list_of_tables.md → src/appendix/list_of_tables.md b/src/list_of_tables.md → src/appendix/list_of_tables.md