Skip to content

Commit

Permalink
Update README.md to add typical issues and their fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
SmartLayer authored Jun 23, 2024
1 parent 7a6e918 commit 624fae5
Showing 1 changed file with 19 additions and 1 deletion.
20 changes: 19 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ This repository hosts the documentation source for both TokenScript and SmartLay
````
$ 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
````
This results a single PDF file: **smart-layer-technical-paper.pdf**.
This result is a single PDF file: **smart-layer-technical-paper.pdf**.
## Directory Overview:
Expand Down Expand Up @@ -104,6 +104,24 @@ $ lftp -c 'open cobalt.primarywebservers.com; mirror -x .git --exclude-glob-from
## Issues and Fixes:
**Error** from running pandoc: `option '--toc' doesn't allow an argument`
**Solution**: Likely because your pandoc version is too low, consider pandoc 3.2.
---
**Error** from running pandoc: `pdflatex not found. Please select a different --pdf-engine or install pdflatex
**Solution**: install the package that provides pdflatex. On Ubuntu/Debian, it is `sudo apt install texlive-latex-base`.
---
**Error** from running pandoc: `! LaTeX Error: File `xcolor.sty' not found.`
**Solution**: install the package that provides it. On Ubuntu/Debian, it is texlive
---
**Error**: `"html5-bootstrap" is not a recognized transformation type`
**Solution**: This arises from an improper installation of `net.infotexture.dita-bootstrap`. Resolve by reinstalling the plugins in the specified order:
Expand Down

0 comments on commit 624fae5

Please sign in to comment.