ScholarMarkdown is Ruby gem for writing scholarly articles in Markdown/HTML. These articles can be viewed in your browser with rich HTML annotations, and they can be printed to PDF into traditional scientific templates via your browser.
It provides an executable (
generate-scholarmd) for initializing a nanoc project
to generate HTML and PDF versions of articles.
ScholarMarkdown consists of a collection of modules that can be configured in your
More information on these modules can be found in the wiki.
1. Use RubyGems to install this bundle:
$ gem install scholarmarkdown
2. Generate your article
This will create a directory
my-awesome-article containing the basic files for a ScholarMarkdown project.
$ generate-scholarmarkdown my-awesome-article $ cd my-awesome-article $ bundle install
If you want to output articles in the double-column ACM template, execute
generate-scholarmarkdown my-awesome-article acm instead.
If you want to output articles in the single-column CEUR ART template, execute
generate-scholarmarkdown my-awesome-article ceur instead.
3. Compile your article
This will start a live webserver that will continuously compile your article files upon any change.
$ bundle exec guard
4. View your article
http://localhost:3000/ in your browser to read your article.
Preview in print-mode to see it in its traditional scientific format.
5. (Optional) Share your article
After compiling your article,
output/ directory will contain the standalone HTML source files of your article,
which can be shared or published anywhere.
This software is released under the MIT license.