Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jorgechato/nerdbook-studio
Easy way to create an epub, pdf, mobi, word... writing in LATEX
https://github.com/jorgechato/nerdbook-studio
Last synced: 27 days ago
JSON representation
Easy way to create an epub, pdf, mobi, word... writing in LATEX
- Host: GitHub
- URL: https://github.com/jorgechato/nerdbook-studio
- Owner: jorgechato
- Created: 2015-08-26T18:12:13.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2016-07-02T08:10:08.000Z (over 8 years ago)
- Last Synced: 2024-11-07T10:45:55.824Z (3 months ago)
- Language: TeX
- Homepage:
- Size: 626 KB
- Stars: 3
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# NerdBook Studio
Easy way to create an epub, pdf, mobi, word... writing in LATEX.
## Dependencies
+ [node](https://nodejs.org/)
+ [LATEX](https://latex-project.org/ftp.html)
+ [TeX4ht/htlatex (only for ebook)](https://www.tug.org/applications/tex4ht/mn.html)
+ [Calibre (only for ebook)](http://calibre-ebook.com/)
[Pandoc](http://pandoc.org/installing.html) is only required to create
.word files but I'm currently working on removing it. You don't need it if you don't want to create .word files
if you are a linux user, you maybe need to install libnotify-bin to get the
notifications system.
```zsh
$ sudo apt-get install libnotify-bin
```
## Download
```zsh
$ git clone https://github.com/orggue/nerdbook-studio.git
```
or download the .zip file [from here](https://github.com/orggue/nerdbook-studio/archive/master.zip).
## Install
```zsh
$ git clone https://github.com/orggue/nerdbook-studio.git
$ cd nerdbook-studio
$ npm install
```
## Run
This will create the .tmp/ and public/ folder, in the future it will allow you to choose the input file between markdown, latex ... and some global variables.
```zsh
$ node init.js
```
To publish your book just type in the console:
```zsh
$ gulp
```
If you only need some of the outputs and not all of them here you have a selection of what can you do:
```zsh
$ gulp pdf # only available in Article environment
$ gulp epub # only available in Book environment
$ gulp mobi # only available in Book environment
$ gulp publish
$ gulp store
```
*gulp publish* generate all outputs depending on which environment did you
choose. **Article** will generate (.pdf and .word), **Book** (.epub, .mobi and
.word).
*gulp store* save the final book into a .zip so you can store your books without non important files, it only store the plain text and the final output.
+ *UPDATE: 2015-12-12* Book enviroment working properly with
multilanguage (Español and English). Images working as espected in
ebooks.
+ *UPDATE: 2015-12-11* PDF output file working properly, I still working on .epub and .mobi to work with images, math and Spanish language.
## Templates
Now with the update (2015-12-09) you have a cool interactive menu to choose the name of the final book, language, write a pdf/word or an ebook and the layout of your project.
### Examples
+ [base](https://github.com/orggue/nerdbook-studio/blob/master/examples/base.pdf)
+ [brain](https://github.com/orggue/nerdbook-studio/blob/master/examples/brain.pdf)
+ [team](https://github.com/orggue/nerdbook-studio/blob/master/examples/team.pdf)
## Structure
```zsh
.
├── .tmp #Temporal files folder
│ ├── book.tex
│ ├── title.opf
│ └── ...
├── book #Studio directory
│ ├── chapters #Folder with all chapters, each chapter in a seperate file
│ │ └── 01-Chapter 1.tex
│ ├── metadata #Personal information and link to packages/style
│ │ ├── footer.tex
│ │ └── header.tex
│ ├── notes #Plus files
│ │ ├── glossary.tex
│ │ ├── mr.tex
│ │ ├── notat.tex
│ │ └── refs.tex
│ └── title.opf #Metadata for the ebook output
├── gulpfile.js
├── images #add as much folders as you want, just remember inject it properly
│ └── 0.jpg
├── init.js #This file will be removed in the installation
├── lib #External packages
│ └── styles #Custom styles
├── package.json
├── config.json
├── public #output folder
│ ├── book.docx
│ ├── book.epub
│ ├── book.mobi
│ └── book.pdf
└── README.md
```
## How to use
You only need to focus in book/ folder. It is made so you can focus in write your book and nothing else.
After you install it and run it you can start editing your book.
First you should change the title.opf with your personal information metadata.
In notes/ folder you have some empty files if you want to add a glossary, references... but you can add new files if you want. Make sure if you add new files you had to include it in the file you want it "as you can see in footer.tex". ex:
```latex
\include{glossary}
```
### Recommendation
The chapters are in book/chapters/ folder, you can add as many as you
want. I recomend to rename it starting with the number of the chapter,
otherwise can be render in a wrong order. I recomend 3 digits, ex:
001-chaptername.tex, 002-chaptername.tex. Then you can name the chapter
as you want inside the file.
### Add images
As you know, you can import images in your book typping:
```latex
\includegraphics{./images/0.jpg}
```
if you want to create different folders to each chapter, create it inside images/ folder and remember import it properly.
```latex
\includegraphics{./images/chapter-1/0.jpg}
```
## External packages and custom style
If you want to add a package do it into /lib folder and remember to add in header.tex:
```latex
\usepackage{packagename}
```
You also have a folder styles/ if you want to create your own style. Remember checking header.tex:
```latex
%Create your own file, mystyle.sty where you put all your own \newcommand statements, for example.
\usepackage{mystyle}
```
## Screenshot
