Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rubensworks/scholarmarkdown
A framework for writing markdown-based scholarly articles.
https://github.com/rubensworks/scholarmarkdown
article html markdown pdf scholarly-articles
Last synced: 17 days ago
JSON representation
A framework for writing markdown-based scholarly articles.
- Host: GitHub
- URL: https://github.com/rubensworks/scholarmarkdown
- Owner: rubensworks
- License: mit
- Created: 2018-04-19T07:48:02.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-11-24T07:41:44.000Z (12 months ago)
- Last Synced: 2024-10-15T07:08:51.503Z (29 days ago)
- Topics: article, html, markdown, pdf, scholarly-articles
- Language: SCSS
- Size: 1.69 MB
- Stars: 42
- Watchers: 3
- Forks: 9
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# 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._
_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
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).