Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nextlevelshit/biutiful-journals
Creating beautifully formated journals with pandoc, Markdown and LaTeX. The included nodejs scripts will support you, having a live preview of the compiled PDF file, you are working on.
https://github.com/nextlevelshit/biutiful-journals
gulp latex live-preview markdown nodejs pandoc pdf-converter watch-changes
Last synced: 25 days ago
JSON representation
Creating beautifully formated journals with pandoc, Markdown and LaTeX. The included nodejs scripts will support you, having a live preview of the compiled PDF file, you are working on.
- Host: GitHub
- URL: https://github.com/nextlevelshit/biutiful-journals
- Owner: nextlevelshit
- Created: 2017-07-10T21:49:27.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2017-07-10T22:44:48.000Z (over 7 years ago)
- Last Synced: 2024-11-19T19:18:47.791Z (3 months ago)
- Topics: gulp, latex, live-preview, markdown, nodejs, pandoc, pdf-converter, watch-changes
- Language: JavaScript
- Homepage: http://www.dailysh.it
- Size: 209 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Biutiful Journals
Creating beautifully formated journals with `pandoc`, `Markdown` and `LaTeX`. The included `nodejs` scripts will support you, having a live preview of the compiled PDF file, you are working on.
## Pre-requirements
In the best case you are using a UNIX-like operating system like `macOS` oder `GNU/Linux`. You will need a `LaTeX` compiler like `pdflatex` and `nodejs` installed.
### 1. Get `LaTeX` and `pandoc`
### 2. Get `nodejs`
`nodejs` is the *de facto* standard for server-side JavaScript programming and is used in our case to stay on track of any changes of the `Markdown` files.
- [Install *nodejs* on Ubuntu](https://wiki.ubuntuusers.de/Node.js/)
- [Install *nodejs* on any other operating system (OS)](https://nodejs.org/en/download/package-manager/)
### 3. Get `yarn` (optional, but recommended)
`yarn` is a node dependency manager that works as a substitute for `npm`, the native `nodejs` package manager. `yarn` includes many improved functionality, but is no must-have. You can also install all dependencies without `yarn` and use `npm` instead. All possibilities will be listed below.
- [Install `yarn` on any OS](https://yarnpkg.com/lang/en/docs/install/)
## Installation of `buitiful-journals`
## Usage
### Watch for changes
Starting the *watch script* with `yarn`:
```bash
yarn start
# equivalent to
npm run start
gulp watch
```
Finally it will always start the gulp task `watch`. Inside the `package.json` there is a section with defined scripts to run.
### Compile to PDF
Compile all `Markdown`(.md) files to PDF:
```bash
yarn pdf
# equivalent to
npm run pdf
gulp pdf
```
## Screenshot
For a perfect usage, I recommend `atom` for developement with a
## Licence
Yeah, it is GPL v2.0. Feel free to use that piece to code!
## Author
I am Michael Czechowski ([www.dailysh.it](http://www.dailysh.it)) web developer from Stuttgart in the deep southern part of Germany. Do not hesitate to contact me: [email protected]