Updating Readme
This commit is contained in:
John Haverlack
parent
15dd6fed2c
commit
28cf868ddf
|
|
@ -3,26 +3,6 @@
|
|||
"id": "13449f33e64774f2",
|
||||
"type": "split",
|
||||
"children": [
|
||||
{
|
||||
"id": "5235c353398dcc73",
|
||||
"type": "tabs",
|
||||
"children": [
|
||||
{
|
||||
"id": "7c859398719a1e19",
|
||||
"type": "leaf",
|
||||
"state": {
|
||||
"type": "markdown",
|
||||
"state": {
|
||||
"file": "README.md",
|
||||
"mode": "source",
|
||||
"source": false
|
||||
},
|
||||
"icon": "lucide-file",
|
||||
"title": "README"
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "f638e1a8b87077ad",
|
||||
"type": "tabs",
|
||||
|
|
@ -33,26 +13,12 @@
|
|||
"state": {
|
||||
"type": "markdown",
|
||||
"state": {
|
||||
"file": "chapters/01_Getting_Started.md",
|
||||
"file": "README.md",
|
||||
"mode": "source",
|
||||
"source": false
|
||||
},
|
||||
"icon": "lucide-file",
|
||||
"title": "01_Getting_Started"
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": "aea7b6310a1ff6ff",
|
||||
"type": "leaf",
|
||||
"state": {
|
||||
"type": "markdown",
|
||||
"state": {
|
||||
"file": "chapters/00_Introduction.md",
|
||||
"mode": "source",
|
||||
"source": false
|
||||
},
|
||||
"icon": "lucide-file",
|
||||
"title": "00_Introduction"
|
||||
"title": "README"
|
||||
}
|
||||
}
|
||||
]
|
||||
|
|
@ -267,8 +233,8 @@
|
|||
"state": {
|
||||
"type": "mathpad-view",
|
||||
"state": {},
|
||||
"icon": "sigma",
|
||||
"title": "Mathpad"
|
||||
"icon": "lucide-ghost",
|
||||
"title": "mathpad-view"
|
||||
}
|
||||
}
|
||||
],
|
||||
|
|
@ -280,19 +246,23 @@
|
|||
},
|
||||
"left-ribbon": {
|
||||
"hiddenItems": {
|
||||
"obsidian-excalidraw-plugin:New drawing": false,
|
||||
"mathpad:Open Mathpad": false,
|
||||
"obsidian-kanban:Create new board": false,
|
||||
"switcher:Open quick switcher": false,
|
||||
"graph:Open graph view": false,
|
||||
"canvas:Create new canvas": false,
|
||||
"templates:Insert template": false,
|
||||
"command-palette:Open command palette": false,
|
||||
"bases:Create new base": false,
|
||||
"obsidian-excalidraw-plugin:New drawing": false,
|
||||
"mathpad:Open Mathpad": false,
|
||||
"obsidian-kanban:Create new board": false
|
||||
"bases:Create new base": false
|
||||
}
|
||||
},
|
||||
"active": "b8c0b940e83a0cce",
|
||||
"lastOpenFiles": [
|
||||
"chapters/02_Features.md",
|
||||
"chapters/00_Introduction.md",
|
||||
"chapters/01_Getting_Started.md",
|
||||
"README.md",
|
||||
"lib/mathjax/output/chtml/fonts/woff-v2/MathJax_Zero.woff",
|
||||
"lib/mathjax/output/chtml/fonts/woff-v2/MathJax_Vector-Regular.woff",
|
||||
"lib/mathjax/output/chtml/fonts/woff-v2/MathJax_Vector-Bold.woff",
|
||||
|
|
@ -303,11 +273,6 @@
|
|||
"lib/mathjax/output/chtml/fonts/woff-v2/MathJax_Size1-Regular.woff",
|
||||
"lib/mathjax/output/chtml/fonts/woff-v2/MathJax_Script-Regular.woff",
|
||||
"lib/mathjax/output/chtml/fonts/woff-v2/MathJax_SansSerif-Regular.woff",
|
||||
"lib/mathjax/output/chtml/fonts/woff-v2/MathJax_SansSerif-Italic.woff",
|
||||
"README.md",
|
||||
"chapters/01_Getting_Started.md",
|
||||
"chapters/00_Introduction.md",
|
||||
"chapters/02_Features.md",
|
||||
"build/lib/img/ACEP Logo for Canvas.png",
|
||||
"build/lib/img/ACEP Logo.png",
|
||||
"build/lib/img/ACEP-50px.png",
|
||||
|
|
|
|||
211
README.md
211
README.md
|
|
@ -2,24 +2,6 @@
|
|||
|
||||
This is a basic book (article) builder template based on a Pandoc build process in conjunction with a number of other tools to generate PDF, ODT, HTML, LaTex, Markdown, and Epub book formats from Markdown source content in an Obsidian vault.
|
||||
|
||||
## Directory Structure
|
||||
|
||||
```
|
||||
basic-book-builder/
|
||||
├── build (Target Destination for Final Outputs)
|
||||
├── chapters (Input Content for the Book)
|
||||
├── conf (Configuration for the Pandoc Builds)
|
||||
├── filters (Filters to control document type formatting)
|
||||
├── lib (Libaries for the Build Process)
|
||||
│ ├── citations
|
||||
│ ├── diag
|
||||
│ ├── img
|
||||
│ └── mathjax
|
||||
├─── scripts (Future Setup Script)
|
||||
│ └── deps
|
||||
└── build.sh (Old Build Script, Depricated in favor of Make)
|
||||
```
|
||||
|
||||
## Usage
|
||||
#### PDF
|
||||
|
||||
|
|
@ -44,194 +26,9 @@ make latex
|
|||
make epub
|
||||
```
|
||||
|
||||
## Dependencies
|
||||
|
||||
For Debian / ZorinOS and likely Ubuntu based systems.
|
||||
## Getting Started
|
||||
|
||||
> It would be nice to roll a setup script to take care of this.
|
||||
#### Zotero
|
||||
|
||||
- https://www.zotero.org/
|
||||
|
||||
```
|
||||
sudo cp ./scripts/deps/zotero.list /etc/apt/sources.list.d/
|
||||
```
|
||||
|
||||
```
|
||||
sudo apt update
|
||||
```
|
||||
|
||||
```
|
||||
sudo apt install zotero
|
||||
```
|
||||
|
||||
#### Better BibTex for Zotero
|
||||
|
||||
Install the Better BibTex Plugin for Zotero
|
||||
- Zotero > Tool > Plugins
|
||||
|
||||
|
||||
#### Export citations.bib
|
||||
|
||||
- Zotero > File > Export Library > Format: Better BibTeX
|
||||
- [ ] Keep Updated
|
||||
- [ ] Save to: ~/Documents/Lib/zotero.bib
|
||||
- [ ] Symlink your ~/Documents/Lib/Citations.bib to basic-book-builder/lib/zotero.bib
|
||||
|
||||
#### Zotero Connector Browser Plugin
|
||||
|
||||
- https://chromewebstore.google.com/detail/zotero-connector/ekhagklcjbdpajgpjgmbionohlpdbjgc
|
||||
|
||||
Provides you the ability to auto add Web resources to your Zotero citation database.
|
||||
#### Obsidian
|
||||
|
||||
- https://obsidian.md/
|
||||
- [Deb Package](https://github.com/obsidianmd/obsidian-releases/releases/download/v1.9.14/obsidian_1.9.14_amd64.deb)
|
||||
|
||||
```
|
||||
sudo apt install https://github.com/obsidianmd/obsidian-releases/releases/download/v1.9.14/obsidian_1.9.14_amd64.deb
|
||||
```
|
||||
|
||||
#### Pandoc
|
||||
|
||||
- https://pandoc.org/
|
||||
- [Download](https://github.com/jgm/pandoc/releases/tag/3.8.2.1)
|
||||
|
||||
```
|
||||
sudo apt install https://github.com/jgm/pandoc/releases/download/3.8.2.1/pandoc-3.8.2.1-1-amd64.deb
|
||||
```
|
||||
#### make
|
||||
|
||||
```
|
||||
sudo apt install make
|
||||
```
|
||||
|
||||
#### jq and yq
|
||||
|
||||
```
|
||||
sudo apt install jq yq
|
||||
```
|
||||
|
||||
|
||||
#### texlive
|
||||
|
||||
```
|
||||
sudo apt install texlive texlive-xetex texlive-latex-extra texlive-fonts-recommended texlive-fonts-extra
|
||||
```
|
||||
#### lmodern
|
||||
|
||||
```
|
||||
sudo apt install lmodern
|
||||
```
|
||||
#### epubcheck
|
||||
|
||||
```
|
||||
sudo apt install epubcheck
|
||||
```
|
||||
#### foliate
|
||||
|
||||
- https://johnfactotum.github.io/foliate/
|
||||
|
||||
```
|
||||
sudo apt install https://github.com/johnfactotum/foliate/releases/download/2.6.4/com.github.johnfactotum.foliate_2.6.4_all.deb
|
||||
```
|
||||
#### calibre
|
||||
|
||||
- https://calibre-ebook.com
|
||||
|
||||
```
|
||||
sudo apt install calibre
|
||||
```
|
||||
|
||||
#### MathJax
|
||||
|
||||
- https://www.mathjax.org/
|
||||
|
||||
```
|
||||
wget https://registry.npmjs.org/mathjax/-/mathjax-3.2.2.tgz
|
||||
tar xzf mathjax-3.2.2.tgz
|
||||
mv package/es5/* lib/mathjax
|
||||
rm -rf package mathjax-3.2.2.tgz
|
||||
```
|
||||
|
||||
# Editing the Book
|
||||
|
||||
### Configuration
|
||||
|
||||
- Edit the `conf/pandoc.yaml` file to add or remove chapter Markdown source `input-files` to the book.
|
||||
|
||||
There are a number of other config files for each format:
|
||||
|
||||
```
|
||||
conf
|
||||
├── epub-metadata.xml
|
||||
├── epub_template.html
|
||||
├── epub.yaml
|
||||
├── frontmatter_epub.md
|
||||
├── frontmatter_epub.xhtml
|
||||
├── frontmatter.html
|
||||
├── frontmatter.tex
|
||||
├── header.tex
|
||||
├── html.yaml
|
||||
├── latex.yaml
|
||||
├── pandoc.yaml
|
||||
├── pdf.yaml
|
||||
├── style.css
|
||||
└── style_epub.css
|
||||
```
|
||||
|
||||
#### Per format Configs
|
||||
- `pdf.yaml`
|
||||
- `html.yaml`
|
||||
- `latex.yaml`
|
||||
- `epub.yaml`
|
||||
|
||||
### FrontMatter Config
|
||||
|
||||
There are 2 Version of the FrontMatter for PDF, and HTML bases formats that set the Title, Author, Verizon, Copyright, etc...
|
||||
|
||||
- `frontmatter.tex`
|
||||
- `frontmatter.html`
|
||||
- `frontmatter_epub.*` - Work in Progress
|
||||
|
||||
> There is probably a better way to do this.
|
||||
|
||||
### Editing Content
|
||||
|
||||
To edit the book open the `basic-book-builder` directory as an Obsidian Vault.
|
||||
|
||||
- Edit the Markdown content in the `chapters` directory.
|
||||
|
||||
### Citations
|
||||
|
||||
> Note: the Zotero database needs configured to export automatically to `lib/citations.bib`
|
||||
|
||||
To insert a Zotero Citation
|
||||
- Ensure the Zotero App and DB are running on you system.
|
||||
- Alt + I (to insert citation)
|
||||
- Search for and select citation reference
|
||||
|
||||
# Building the Book
|
||||
|
||||
#### PDF
|
||||
|
||||
```
|
||||
make pdf
|
||||
```
|
||||
#### HTML
|
||||
|
||||
```
|
||||
make html
|
||||
```
|
||||
#### LaTex
|
||||
|
||||
```
|
||||
make latex
|
||||
```
|
||||
#### EPub
|
||||
|
||||
> Note: This configuration still needs work.
|
||||
|
||||
```
|
||||
make epub
|
||||
```
|
||||
Download PDF or HTML version of the b3 book. Which self documents how to use this template:
|
||||
- [b3.pdf ](build/b3.pdf)
|
||||
- [b3.html](build/b3.html)
|
||||
|
|
|
|||
Loading…
Reference in New Issue