www/posts/markdown/atom.xml


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53

<?xml version="1.0" encoding="utf-8"?>
<feed xmlns="http://www.w3.org/2005/Atom">
    <title type="text">The Home of David T. Sadler - All Posts About Markdown</title>
    <id>https://davidtsadler.com/posts/markdown/atom.xml</id>
    <link rel="alternate" type="text/html" href="https://davidtsadler.com/posts/markdown/index.html"/>
    <link rel="self" type="application/atom+xml" href="https://davidtsadler.com/posts/markdown/atom.xml"/>
    <updated>2020-03-30T12:00:00Z</updated>
    <entry>
    <title type="text">Creating an Ebook With Markdown</title>
    <id>https://davidtsadler.com/posts/markdown/2020-03-30/creating-an-ebook-with-markdown/index.html</id>
    <link rel="alternate" type="text/html" href="https://davidtsadler.com/posts/markdown/2020-03-30/creating-an-ebook-with-markdown/index.html"/>
    <author><name>David T. Sadler.</name></author>
    <published>2020-03-30T12:00:00Z</published>
    <updated>2020-03-30T12:00:00Z</updated>
    <content type="html">&lt;h1&gt;Creating an Ebook With Markdown&lt;/h1&gt;&lt;blockquote&gt;Mon 30th March 2020 By David T. Sadler.&lt;/blockquote&gt;&lt;p&gt;Pandoc is a great tool for converting a file in one markup format into another. This means we can use it to convert a file written in Markdown into an EPUB file that is supported by many e-readers.&lt;/p&gt;&lt;p&gt;Lets start by writting a very simple markdown file called example_ebook.md.&lt;/p&gt;&lt;pre&gt;&lt;code class=&quot;markdown&quot;&gt;---
title:
- type: main
  text: Example Ebook
- type: subtitle
  text: An Ebook created from a Markdown file
creator:
- role: author
  text: David Sadler
publisher: Published by myself
---

This is an introduction.

# Chapter 1

This is the first paragraph of chapter 1.

This is the second paragraph of chapter 1.

Below is a list.

- Item One
- Item Two
- Item Three

# Chapter 2

This is the first paragraph of chapter 2.

This is the second paragraph of chapter 2.

# Chapter 3

This is the first paragraph of chapter 3.

This is the second paragraph of chapter 3.&lt;/code&gt;&lt;/pre&gt;&lt;p&gt;Note that the file begins with a YAML metadata block that starts and ends with three hyphens (---). This allows you to specify EPUB metadata such as the title and author.&lt;/p&gt;&lt;p&gt;Converting this to EPUB is done by running pandoc.&lt;/p&gt;&lt;pre&gt;&lt;code class=&quot;shell&quot;&gt;$ pandoc example_ebook.md -t epub3 --toc -o example_ebook.epub&lt;/code&gt;&lt;/pre&gt;&lt;p&gt;There are several options that need to be passed to pandoc.&lt;/p&gt;&lt;ul&gt;&lt;li&gt;example_ebook.md - This argument is the file that you are converting.&lt;/li&gt;&lt;li&gt;-t epub3 - Set the output format to be EPUB v3 book.&lt;/li&gt;&lt;li&gt;--toc - Include a table of contents in the output document. This will be derived from the H1 headers in the markdown.&lt;/li&gt;&lt;li&gt;-o example_ebook.epub - Tell pandoc to output the conversion to the named file instead of stdout.&lt;/li&gt;&lt;/ul&gt;&lt;p&gt;You can now copy the file example_ebook.epub to any device that supports the format or use one of the many software readers such as Calibre. However, if you wish to read this on a Kindle device you will need to convert it to the Mobi format.&lt;/p&gt;&lt;p&gt;Amazon provides a command line tool called KindleGen that can convert our EPUB file into the Mobi format. After downloading the tool just run it as shown below.&lt;/p&gt;&lt;pre&gt;&lt;code class=&quot;shell&quot;&gt;$ kindlegen example_ebook.epub&lt;/code&gt;&lt;/pre&gt;&lt;p&gt;This will create a file called example_ebook.mobi that you can copy to your Kindle to read.&lt;/p&gt;&lt;h3&gt;Links&lt;/h3&gt;&lt;a href=&quot;https://pandoc.org/&quot;&gt;Pandoc.&lt;/a&gt;&lt;a href=&quot;https://en.wikipedia.org/wiki/Markdown/&quot;&gt;Markdown.&lt;/a&gt;&lt;a href=&quot;https://en.wikipedia.org/wiki/EPUB/&quot;&gt;EPUB.&lt;/a&gt;&lt;a href=&quot;https://pandoc.org/MANUAL.html#extension-yaml_metadata_block&quot;&gt;YAML metadata block.&lt;/a&gt;&lt;a href=&quot;https://pandoc.org/MANUAL.html#epub-metadata&quot;&gt;EPUB metadata.&lt;/a&gt;&lt;a href=&quot;https://www.w3.org/community/epub3/&quot;&gt;EPUB v3 book.&lt;/a&gt;&lt;a href=&quot;https://calibre-ebook.com/&quot;&gt;Calibre Application.&lt;/a&gt;&lt;a href=&quot;https://en.wikipedia.org/wiki/Comparison_of_e-book_formats#Mobipocket&quot;&gt;Mobi Format.&lt;/a&gt;&lt;a href=&quot;https://www.amazon.com/gp/feature.html?ie=UTF8&amp;amp;docId=1000765211&quot;&gt;KindleGen Application.&lt;/a&gt;&lt;a href=&quot;/posts/markdown/&quot;&gt;Markdown - Read More Posts.&lt;/a&gt;&lt;p&gt;I don't have comments as I don't want to manage them. You can however contact me at the below address if you want to.&lt;/p&gt;&lt;a href=&quot;mailto:david@davidtsadler.com&quot;&gt;Email david@davidtsadler.com&lt;/a&gt;&lt;h3&gt;License&lt;/h3&gt;&lt;a href=&quot;https://creativecommons.org/licenses/by-sa/4.0/&quot;&gt;The contents of this site is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License.&lt;/a&gt;&lt;p&gt;Copyright © 2021 David T. Sadler.&lt;/p&gt;&lt;a href=&quot;/&quot;&gt;Return to Homepage.&lt;/a&gt;</content>
</entry>
</feed>