jakobib/makedoc

Templates and Makefiles to build publication in multiple formats based on a source file in Pandoc Markdown

makedoc

makedoc ist a git repository containing Makefiles and templates to create papers and presentations from source files in Pandoc Markdown. The current version can be found at https://github.com/jakobib/makedoc. Feel free to comment, reuse, fork, and modify!

makedoc is accompanied by makespec, a similar tool to create specifications (makedoc and makespec may later be merged).

Usage

First steps

1. Create a directory for your publication (possibly as git repository).

   mkdir example
   cd example
   git init
   

2. Check out this module in a subdirectory called 'make' (possibly as git submodule):

   git submodule add https://github.com/jakobib/makedoc.git
   

3. Create a Makefile that at least contains include makedoc/Makefile.

4. Optionally create the file metadata.ini with title, abstract, keywords. This will be passed to templates.

Commands

make foo.html creates HTML from a markdown file foo.md. Use make -B foo.html to force creation.

make normalize normalizes all .md files in the current directory. A backup is created with file extension .md.bak.

make clean removes all backup files and build artifacts.

makedoc's Issues

Example for pdf-paper?

Hi,

I just found makedoc and it is pretty much what I am trying to do with pandoc (writing a lncs paper with markdown)

Do you have an example how to use it for paper generation, yet? I saw that this feature is not yet finished, but maybe there is something to work on, already ;-).

Regards

Better align with makespec

makespec is a fork of makedoc that is more elaborated in some parts. Makedoc and makespec should either merge or better keep in sync with makespec being a particular configuration of makedoc.