Sha256: 9f4da787a40fcd477ae49ccace8fbf20bd7e7bba96f47467f4602bb5d68a8e37
Contents?: true
Size: 1.89 KB
Versions: 13
Compression:
Stored size: 1.89 KB
Contents
# ScholarMarkdown [](https://rubygems.org/gems/scholarmarkdown) 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](https://nanoc.ws/) project to generate HTML and PDF versions of articles. ScholarMarkdown consists of a collection of modules that can be configured in your `Rules` file. More information on these modules can be found in the [wiki](https://github.com/rubensworks/ScholarMarkdown/wiki/Modules). ## Quick Start #### 1. Use RubyGems to install this bundle: ```bash $ gem install scholarmarkdown ``` #### 2. Generate your article _This will create a directory `my-awesome-article` containing the basic files for a ScholarMarkdown project._ ```bash $ 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._ #### 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 Visit `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, the `output/` directory will contain the standalone HTML source files of your article, which can be shared or [published](https://github.com/rubensworks/ScholarMarkdown/wiki/Self-publishing) anywhere. ## License This software is released under the [MIT license](http://opensource.org/licenses/MIT).
Version data entries
13 entries across 13 versions & 1 rubygems