Code Monkey home page Code Monkey logo

pandoc-htmldocs's Introduction

title
cdituri/pandoc-htmldocs

cdituri/pandoc-htmldocs is a docker image which renders self-contained, single-page HTML from a set of markdown input files. The markdown input files and their build order are defined in build.docs.json.

Overview

cdituri/pandoc-htmldocs searches for the build.docs.json document at container run-time. Based on the order definied in the json document, a self-contained, single-page HTML file is generated, directed to stdout.

Build docker image

# from the git repository root, run:
docker build -t cdituri/pandoc-htmldocs src/

# optionally, use this shell script:
# ./build.container.sh

Create build.docs.json

Ensure that a build.docs.json file exists. The build.docs.json of this repository provides the following example:

[
    "README.md"
]

Build documentation

# from the git repository root, run:
docker run --rm -v "$(pwd):/src/" cdituri/pandoc-htmldocs > index.html

# optionally, use this shell script:
# ./build.docs.sh > index.html

Render screenshot

Screenshot

pandoc-htmldocs's People

Contributors

cdituri avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.