pub2¶
Pub2 is a self-publishing framework.
Overview¶
Pub2 is a self-publishing framework. It integrates with Jekyll to provide LaTeX publishing.
Online Resources¶
Quick Start¶
The following command installs pub2 using Python pip.
pip install pub2
The following commands initialize the current directory and build a sample. The results appear in the pub2 folder.
pub2 init
pub2 build
ls pub2/*.pdf
Requirements¶
A TeX installation and ImageMagick are also required. See installation to install on macOS, Windows, and Linux (Debian/Ubuntu or Redhat/CentOS).
About¶
Installation¶
pub2 depends on TeX Live and ImageMagick. To install, use pip.
OSX¶
Install mactex and imagemagick using Homebrew, then install pub2.
brew cask install mactex
brew install imagemagick
pip install pub2
Linux (Debian/Ubuntu)¶
Install magickwand-dev and texlive, then pub2.
apt-get install libmagickwand-dev texlive
pip install pub2
Linux (Redhat/CentOS)¶
Install imagemagck and texlive, then pub2.
yum install ImageMagick-devel texlive-latex
pip install pub2
Windows¶
- Install TeX: http://mirror.ctan.org/systems/texlive/tlnet/install-tl-windows.exe
- Install ImageMagick: http://docs.wand-py.org/en/0.4.3/guide/install.html#install-imagemagick-on-windows
- Think happy thoughts.
pip install pub2
Usage¶
Initialization¶
Pub2 requires Jekyll to work. In the root directory of a Jekyll project, run the init command.
pub2 init
The init command will create the following files:
- /_pub2
- /_pages/pub2.html
The next time the Jekyll site is rebuilt, these files will be detected.
Pre-requisite: Jekyll¶
You can quickly scaffold a Jekyll website using diamond-patterns.
pip install diamond-patterns
diamond pattern website
License¶
The MIT License (MIT)
pub Copyright (c) 2016 Ian Dennis Miller
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.