Markdown Book

The Markdown-Book Book

Markdown Book is a JavaScript application that displays books of Markdown files. To create a Markdown Book, perform the following instructions.

First, create the markdown book file, book.json. The markdown book file is defined as Markdown Book JSON format.

{
    "title": "The Book Title",
    "titleURL": "title.md",
    "headerColor": "lightgray",
    "titleColor": "lightblue",
    "categories": [
        {
            "title": "Table of Contents",
            "files": [
                "page.md"
            ]
        }
    ]
}

Next, create the title markdown file, title.md.

# The Book Title

Click [here](#id=page) to get started.

Next, add the markdown file, page.md.

# The Page Title

This is the page text.

Finally, download the Markdown Book application stub, index.html.

curl -O https://craigahobbs.github.io/markdown-book-app/static/index.html

To host your book locally, start a local static web server:

python3 -m http.server

Development

markdown-book-app is an Element Application. It is developed using javascript-build and it was started using javascript-template:

template-specialize javascript-template/template/ markdown-book-app/ -k package markdown-book-app -k name 'Craig A. Hobbs' -k email 'craigahobbs@gmail.com' -k github 'craigahobbs'