Skip to content

Commit 624fae5

Browse files
authored
Update README.md to add typical issues and their fixes
1 parent 7a6e918 commit 624fae5

File tree

1 file changed

+19
-1
lines changed

1 file changed

+19
-1
lines changed

README.md

+19-1
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ This repository hosts the documentation source for both TokenScript and SmartLay
5656
````
5757
$ pandoc --resource-path=src/papers --csl src/papers/chicago-note-bibliography.csl --citeproc --bibliography src/papers/smart-layer-technical-paper.bib -o out/smartlayer-technical-paper.pdf src/papers/smart-layer-technical-paper.md
5858
````
59-
This results a single PDF file: **smart-layer-technical-paper.pdf**.
59+
This result is a single PDF file: **smart-layer-technical-paper.pdf**.
6060
6161
## Directory Overview:
6262
@@ -104,6 +104,24 @@ $ lftp -c 'open cobalt.primarywebservers.com; mirror -x .git --exclude-glob-from
104104
105105
## Issues and Fixes:
106106
107+
**Error** from running pandoc: `option '--toc' doesn't allow an argument`
108+
109+
**Solution**: Likely because your pandoc version is too low, consider pandoc 3.2.
110+
111+
---
112+
113+
**Error** from running pandoc: `pdflatex not found. Please select a different --pdf-engine or install pdflatex
114+
115+
**Solution**: install the package that provides pdflatex. On Ubuntu/Debian, it is `sudo apt install texlive-latex-base`.
116+
117+
---
118+
119+
**Error** from running pandoc: `! LaTeX Error: File `xcolor.sty' not found.`
120+
121+
**Solution**: install the package that provides it. On Ubuntu/Debian, it is texlive
122+
123+
---
124+
107125
**Error**: `"html5-bootstrap" is not a recognized transformation type`
108126
109127
**Solution**: This arises from an improper installation of `net.infotexture.dita-bootstrap`. Resolve by reinstalling the plugins in the specified order:

0 commit comments

Comments
 (0)