https://github.com/sphericalkat/gopherpress
A simple tool to generate an epub book from a (properly) formatted markdown file.
https://github.com/sphericalkat/gopherpress
ebook epub go html markdown
Last synced: 10 months ago
JSON representation
A simple tool to generate an epub book from a (properly) formatted markdown file.
- Host: GitHub
- URL: https://github.com/sphericalkat/gopherpress
- Owner: SphericalKat
- License: mit
- Created: 2024-11-02T10:28:52.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-12-05T02:02:29.000Z (over 1 year ago)
- Last Synced: 2024-12-17T18:56:05.586Z (over 1 year ago)
- Topics: ebook, epub, go, html, markdown
- Language: Go
- Homepage:
- Size: 349 KB
- Stars: 9
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# gopherpress
A simple tool to generate an epub book from a (properly) formatted markdown file.
## Installation
You can install the latest `gopherpress` snapshot using `go install`:
```bash
go install github.com/sphericalkat/gopherpress@latest
```
Instructions for installing the latest binary release can be found in the [wiki](https://github.com/SphericalKat/gopherpress/wiki/Installation)
## Description
`gopherpress` is a command-line tool with very few options. It reads a markdown file and generates an epub file. The markdown file must be formatted in a specific way. The first three lines of the file should be a YAML front matter block.
```
NAME:
gopherpress - Turn HTML into an ebook using Markdown
USAGE:
gopherpress [global options] command [command options]
COMMANDS:
help, h Shows a list of commands or help for one command
GLOBAL OPTIONS:
--input value, -i value Input file (Markdown)
--output value, -o value Output file (epub) (default: "output.epub")
--help, -h show help
```
Given this input:
```
---
title: Crafting Interpreters
author: Robert Nystrom
summary: This book teaches you everything you need to know to implement a full-featured, efficient scripting language. You'll learn both high-level concepts around parsing and semantics and gritty details like bytecode representation and garbage collection. Your brain will light up with new ideas, and your hands will get dirty and calloused.
cover: https://craftinginterpreters.com/image/header.png
---
# Crafting Interpreters
# [Chapter 1: The Lox Language](https://craftinginterpreters.com/the-lox-language.html)
# [Chapter 2: Scanning](https://craftinginterpreters.com/scanning.html)
```
It will generate an epub file with the title "Crafting Interpreters" and the author "Robert Nystrom". The chapters will be displayed in the order they appear in the markdown file.
