Metadata to get rid of EPUB warnings, plus Windows install notes
This commit is contained in:
parent
9b18a5b272
commit
8a1ab3ad61
|
@ -21,6 +21,12 @@ The Pangamebook filter itself does not have to be installed. The file
|
|||
*pangamebook.lua* must be copied to somewhere on your computer and
|
||||
named on the command-line when running pandoc (see examples below).
|
||||
|
||||
## Windows
|
||||
Install Pandoc. Install MikTex (as linked from the Pandoc download page).
|
||||
Restart computer. Download *pangamebook.lua* and *example.md*.
|
||||
That should be enough to be able to run all the
|
||||
examples below. Otherwise search for help.
|
||||
|
||||
# Input Document
|
||||
First you need to write your gamebook. The recommended format is [Pandoc's
|
||||
Markdown](https://pandoc.org/MANUAL.html#pandocs-markdown). That is the format
|
||||
|
|
13
example.md
13
example.md
|
@ -1,8 +1,19 @@
|
|||
# Pangamebook Example Gamebook
|
||||
---
|
||||
title: Pangamebook Gamebook Example
|
||||
author: Pelle Nilsson
|
||||
---
|
||||
|
||||
# Pangamebook Gamebook Example
|
||||
This is just an example to give new users and idea where to start. See [Pandoc
|
||||
Getting Started Article](https://pandoc.org/getting-started.html) and
|
||||
[PangamebookREADME](README.md) for more information.
|
||||
|
||||
The lines at the very top of this file are needed to add some metadata
|
||||
for the book. Otherwise there are ugly warnings when creating EPUB files
|
||||
and possibly for other formats as well. Good to always include some
|
||||
lines like that. Normally they are invisible and should not show
|
||||
up in the output at all.
|
||||
|
||||
# Introduction
|
||||
Sections with a header like this one will not be affected by the Pangamebook
|
||||
filter, as described in the README.
|
||||
|
|
Loading…
Reference in a new issue