Skip to content

Latest commit

 

History

History
108 lines (64 loc) · 2.89 KB

README.md

File metadata and controls

108 lines (64 loc) · 2.89 KB
Raw

Markdown Papers 0.1

[@dracoblue] (http://github.com/dracoblue), [@rmetzler] (http://github.com/rmetzler)

Abstract

The idea is to use a specific markdown file to write proper formatted papers and articles. It's still work in progress and only pre-alpha, but already looks quite nice.

Keywords

markdown, javascript, llncs

Example

You can use this README.md as source and generate a .html by using:

$ bin/markdown-papers README.md README.html

The output should look like that:

Example Output

Pre-Conditions

You need [node.js] (http://nodejs.org), [npm] (http://npmjs.org) and the [CMU Fonts] (http://cm-unicode.sourceforge.net/) (optional, will fallback to default serif font) installed.

node.js Dependencies

Use

$ ./configure

to automaticly resolve those by using [npm] (http://npmjs.org).

Installation

It's quite simple to test the current version.

Get your self a copy and configure it with npm:

$ git clone git://github.com/DracoBlue/markdown-papers.git
$ cd markdown-papers
$ ./configure

Now, test it:

$ bin/markdown-papers README.md README.html

and it will generate the README.md as a nicely formatted one.

Command line option: --template

If you want to use a different template (located at lib/templates/*.html), you must use the --template option.

$ bin/markdown-papers --template twocol README.md README.html

This will convert the .md-File by using the lib/templates/twocol.html template. You could put your own templates into that folder to make them available for the markdown-papers script.

Rules for the .md-File

Even though this is still work in progress, here are the current rules for the document.

  1. Use # Title for the title of the Paper
  2. Every text after the title will be used as author and aligned in center.
  3. Use ### Abstract and ### Keywords to provide those sections with content.
  4. Every following ## Item will be added to the table of contents and is a section.

Very simple example:

# My Paper
Mr. Author

### Abstract
This is a short one!

### Keywords
example, markdown

## Introduction
And so on

## Conclusion
Awesome

You can also use this README.md as example.

ToDo

  • clean up and document code
  • add print style sheet
  • generate .pdf files

Changelog

  • 2012/29/01
  • added MarkdownPaper#setTemplate(template_name), which loads templates/{template_name}.html.
  • renamed screen.css to screen.default.css
  • added test for template without abstract+keywords
  • added first test for twocol-layout
  • added command line option --template

License

markdown-papers is available under the terms of MIT License.