{"id":17021950,"url":"https://github.com/rubensworks/scholarmarkdown","last_synced_at":"2025-04-05T16:04:45.369Z","repository":{"id":37432558,"uuid":"130178199","full_name":"rubensworks/ScholarMarkdown","owner":"rubensworks","description":"A framework for writing markdown-based scholarly articles.","archived":false,"fork":false,"pushed_at":"2025-02-28T11:48:44.000Z","size":1758,"stargazers_count":44,"open_issues_count":10,"forks_count":9,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-29T15:03:40.874Z","etag":null,"topics":["article","html","markdown","pdf","scholarly-articles"],"latest_commit_sha":null,"homepage":null,"language":"SCSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rubensworks.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-04-19T07:48:02.000Z","updated_at":"2025-03-14T13:12:33.000Z","dependencies_parsed_at":"2024-10-27T12:49:55.117Z","dependency_job_id":"74c1d599-2e92-4ea5-860d-e26410f00e6b","html_url":"https://github.com/rubensworks/ScholarMarkdown","commit_stats":null,"previous_names":[],"tags_count":24,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rubensworks%2FScholarMarkdown","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rubensworks%2FScholarMarkdown/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rubensworks%2FScholarMarkdown/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rubensworks%2FScholarMarkdown/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rubensworks","download_url":"https://codeload.github.com/rubensworks/ScholarMarkdown/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247361615,"owners_count":20926642,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["article","html","markdown","pdf","scholarly-articles"],"created_at":"2024-10-14T07:08:59.253Z","updated_at":"2025-04-05T16:04:45.345Z","avatar_url":"https://github.com/rubensworks.png","language":"SCSS","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ScholarMarkdown\n[![scholarmarkdown gem version](https://badge.fury.io/rb/scholarmarkdown.svg)](https://rubygems.org/gems/scholarmarkdown)\n\nScholarMarkdown 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.\n\nIt provides an executable (`generate-scholarmd`) for initializing a [nanoc](https://nanoc.ws/) project\nto generate HTML and PDF versions of articles.\n\nScholarMarkdown consists of a collection of modules that can be configured in your `Rules` file.\nMore information on these modules can be found in the [wiki](https://github.com/rubensworks/ScholarMarkdown/wiki/Modules).\n\n## Quick Start\n\n#### 1. Use RubyGems to install this bundle:\n\n```bash\n$ gem install scholarmarkdown\n```\n\n#### 2. Generate your article\n\n_This will create a directory `my-awesome-article` containing the basic files for a ScholarMarkdown project._\n\n```bash\n$ generate-scholarmarkdown my-awesome-article\n$ cd my-awesome-article\n$ bundle install\n```\n\n_If you want to output articles in the double-column ACM template, execute `generate-scholarmarkdown my-awesome-article acm` instead._\n\n_If you want to output articles in the single-column CEUR ART template, execute `generate-scholarmarkdown my-awesome-article ceur` instead._\n\n#### 3. Compile your article\n\n_This will start a live webserver that will continuously compile your article files upon any change._\n\n```\n$ bundle exec guard\n```\n\n#### 4. View your article\n\nVisit `http://localhost:3000/` in your browser to read your article.\n\nPreview in print-mode to see it in its traditional scientific format.\n\n#### 5. _(Optional)_ Share your article\n\nAfter compiling your article,\nthe `output/` directory will contain the standalone HTML source files of your article,\nwhich can be shared or [published](https://github.com/rubensworks/ScholarMarkdown/wiki/Self-publishing) anywhere.\n\n## License\nThis software is released under the [MIT license](http://opensource.org/licenses/MIT).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frubensworks%2Fscholarmarkdown","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frubensworks%2Fscholarmarkdown","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frubensworks%2Fscholarmarkdown/lists"}