forked from trent_larson/crowd-funder-for-time-pwa
rename "docs" directory to "doc"
This commit is contained in:
66
doc/README.md
Normal file
66
doc/README.md
Normal file
@@ -0,0 +1,66 @@
|
||||
# TimeSafari Docs
|
||||
|
||||
## Generating PDF from Markdown on OSx
|
||||
|
||||
This uses Pandoc and BasicTex (LaTeX) Installed through Homebrew.
|
||||
|
||||
### Set Up
|
||||
|
||||
```bash
|
||||
# See https://daniel.feldroy.com/posts/setting-up-latex-on-mac-os-x
|
||||
brew install pandoc
|
||||
|
||||
brew install basictex
|
||||
|
||||
pandoc keystore-migration.md -o keystore-migration.pdf
|
||||
|
||||
# Setting up LaTex packages
|
||||
|
||||
# First update tlmgr
|
||||
sudo tlmgr update --self
|
||||
|
||||
# Then install LaTex packages
|
||||
sudo tlmgr install titlesec
|
||||
sudo tlmgr install framed
|
||||
sudo tlmgr install threeparttable
|
||||
sudo tlmgr install wrapfig
|
||||
sudo tlmgr install multirow
|
||||
sudo tlmgr install enumitem
|
||||
sudo tlmgr install bbding
|
||||
sudo tlmgr install titling # Required for the fancy headers used
|
||||
sudo tlmgr install tabu
|
||||
sudo tlmgr install mdframed
|
||||
sudo tlmgr install tcolorbox
|
||||
sudo tlmgr install textpos
|
||||
sudo tlmgr install import
|
||||
sudo tlmgr install varwidth
|
||||
sudo tlmgr install needspace
|
||||
sudo tlmgr install tocloft # Required for \tableofcontents generation
|
||||
sudo tlmgr install ntheorem
|
||||
sudo tlmgr install environ
|
||||
sudo tlmgr install trimspaces
|
||||
sudo tlmgr install lastpage # Enables Page X of Y
|
||||
sudo tlmgr install collection-fontsrecommended # And set up fonts
|
||||
sudo tlmgr install libertine # The main font the doc uses
|
||||
|
||||
|
||||
```
|
||||
|
||||
### Usage
|
||||
|
||||
Use the `pandoc` command to generate a PDF.
|
||||
|
||||
```bash
|
||||
pandoc usage-guide.md -o usage-guide.pdf
|
||||
```
|
||||
|
||||
And you can open the PDF with the `open` command.
|
||||
|
||||
```bash
|
||||
open usage-guide.pdf
|
||||
```
|
||||
|
||||
Or use this one-liner
|
||||
```bash
|
||||
pandoc usage-guide.md -o usage-guide.pdf && open usage-guide.pdf
|
||||
```
|
||||
Reference in New Issue
Block a user