Giter Club home page Giter Club logo

mdmake's Introduction

npm script for creating a markdown template: [filename].md + Makefile -> [filename].pdf

Creating a project

[some-folder]$ npx @bergkvist/mdmake [filename]

This will create a Makefile as well as [filename].md in the current folder.

Usage after creation

# Compile [filename].md to [filename].pdf
[some-folder]$ make

# Run make automatically whenever [filename].md changes.
[some-folder]$ make watch

# Preview pdf (with automatic updates) in zathura pdf viewer.
[some-folder]$ make preview

# Open file for editing in gedit
[some-folder]$ make edit

Requirements

  • pandoc with pdf-latex (for compiling from [filename].md -> [filename].pdf)
  • zathura (for opening pdf-preview)
  • entr (for watching file changes)
  • make (for using the make commands)
  • gedit (for using make edit)

mdmake's People

Contributors

bergkvist avatar

Watchers

 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.