Giter Club home page Giter Club logo

murdoc's Introduction

Murdoc

Murdoc is a lightweight publishing framework where you write in Markdown and can export to multiple formats. I wrote it primarily as a tool for writing technical documentation that I could then publish as a site and as a PDF.

The output can be styled but for this you'll need some expertise in HTML, CSS and LaTex.

Features

  • Write everything in Kramdown, a superset of Markdown.
  • Simple folder-based structure. Murdoc takes care of stitching everything together. Anyone familiar with daux.io should feel right at home.
  • Wiki-style links based on kramdowns automatic generation of header IDs.
  • Output to multiple formats:
    • static HTML using Jekyll
    • PDF (using LaTeX).
    • ePub support will be available in the near future.
  • Templates: customize each output format by providing your own HTML, CSS or LaTeX code.
  • Built-in webserver using express.
  • Built-in folder watching using chokidar: any changes made to the documentation or the templates will automatically re-build the outputs.

Installation

Murdoc is available through npm.

npm install -g murdoc

Dependencies

Make sure the following tools are also installed:

Getting Started

Create a new Murdoc project and publish it to html.

murdoc --create --docs folder-name --watch --serve --output=html

Next direct your browser to http://localhost:4000 and you will see the Murdoc documentation. The next time you want to work on a project you can use:

murdoc --docs folder-name --watch --serve --output=html

In 'folder-name' you will now find three folders:

  • docs: the content of your document. We've already put the documentation for Murdoc here, so you have a good example to start from.
  • build: any build output is found here. The static sites end up in build/jekyll/_site. The PDF is written to build/latex/main.pdf.
  • templates: When creating the project we copied in our default templates. Feel free to modify them to your needs, that's what they are there for.

murdoc's People

Contributors

mvhaen avatar

Watchers

 avatar  avatar

murdoc's Issues

Unable to install on Ubuntu 15.10

When trying to install on Ubuntu, the following occurs

builder@builder2:~/novanode/documentation$ sudo npm install -g murdoc
npm WARN optional dep failed, continuing [email protected]
/
> [email protected] install /usr/lib/node_modules/murdoc/node_modules/execSync
> node install.js

[execsync v1.0.2] Attempting to compile native extensions.
[execSync v1.0.2]
    Native code compile failed!!
/usr/bin/murdoc -> /usr/lib/node_modules/murdoc/murdoc.js
[email protected] /usr/lib/node_modules/murdoc
├── [email protected]
├── [email protected] ([email protected], [email protected])
├── [email protected] ([email protected], [email protected])
├── [email protected] ([email protected], [email protected], [email protected], [email protected], [email protected], [email protected], [email protected], [email protected], [email protected], [email protected], [email protected], [email protected], [email protected], [email protected], [email protected], [email protected], [email protected], [email protected], [email protected], [email protected], [email protected], [email protected], [email protected], [email protected], [email protected])
├── [email protected] ([email protected])
├── [email protected] ([email protected], [email protected], [email protected], [email protected], [email protected])
├── [email protected] ([email protected], [email protected], [email protected], [email protected], [email protected], [email protected], [email protected], [email protected], [email protected])
├── [email protected] ([email protected], [email protected], [email protected], [email protected], [email protected])
└── [email protected] ([email protected], [email protected])

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.