{"id":13601813,"url":"https://github.com/prosegrinder/pandoc-templates","last_synced_at":"2025-10-20T05:58:39.908Z","repository":{"id":29061511,"uuid":"120123961","full_name":"prosegrinder/pandoc-templates","owner":"prosegrinder","description":"An opinionated set of Pandoc templates and scripts for converting markdown to DOCX manuscripts that adhere to William Shunn's Proper Manuscript Format guidelines using Pandoc.","archived":false,"fork":false,"pushed_at":"2022-12-06T22:59:54.000Z","size":395,"stargazers_count":67,"open_issues_count":3,"forks_count":15,"subscribers_count":4,"default_branch":"main","last_synced_at":"2024-08-02T18:41:19.176Z","etag":null,"topics":["docx","fiction","markdown","pandoc","publishing"],"latest_commit_sha":null,"homepage":"http://www.prosegrinder.com/pandoc-templates","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/prosegrinder.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-02-03T19:48:13.000Z","updated_at":"2024-07-14T02:45:19.000Z","dependencies_parsed_at":"2023-01-14T14:03:41.925Z","dependency_job_id":null,"html_url":"https://github.com/prosegrinder/pandoc-templates","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/prosegrinder%2Fpandoc-templates","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/prosegrinder%2Fpandoc-templates/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/prosegrinder%2Fpandoc-templates/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/prosegrinder%2Fpandoc-templates/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/prosegrinder","download_url":"https://codeload.github.com/prosegrinder/pandoc-templates/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223458642,"owners_count":17148492,"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":["docx","fiction","markdown","pandoc","publishing"],"created_at":"2024-08-01T18:01:08.311Z","updated_at":"2025-10-20T05:58:39.858Z","avatar_url":"https://github.com/prosegrinder.png","language":"Shell","funding_links":[],"categories":["Shell"],"sub_categories":[],"readme":"# Pandoc Templates\n\nAn opinionated set of Pandoc templates and scripts for converting markdown to DOCX manuscripts\nthat adhere to [William Shunn's Proper Manuscript Format](https://www.shunn.net/format/)\nguidelines using [Pandoc](https://pandoc.org).\n\n## Getting Started\n\nThese templates and scripts aim to be easy to install and use, and consistent across Windows, Mac, and Linux. I generally use Mac and Linux at home, so Windows scripts may lag behind those.\n\n### Requirements\n\n* [Pandoc](https://pandoc.org) version 2.0 or greater.\n\n### Pandoc\n\nSee the Pandoc site for [full installation](https://pandoc.org/installing.html) instructions. For Linux, I strongly suggest using [LinuxBrew](http://linuxbrew.sh/) instead of your distribution's package manager for the same reason given in the Pandoc installation instructions. Install LinuxBrew and follow the instructions for installing on Mac via HomeBrew. Versions packaged by your distribution may be too old.\n\n### Markdown\n\nThese templates only work for short and long fiction written in Markdown. See [Sustainable Authorship in Plain Text using Pandoc and Markdown](https://programminghistorian.org/lessons/sustainable-authorship-in-plain-text-using-pandoc-and-markdown#philosophy) if you're interested in my motivation. I hope one day soon publishers in the fiction markets will prefer submissions in Markdown over DOCX as it minimized the burden of typsetting on the author and is relatively easy to convert to many other formats (e.g. using Pandoc).\n\n## Installation\n\nOnce you have [Pandoc](https://pandoc.org) set up, you'll need to copy these files to your local machine.\n\n### Install via Download\n\nIf you're not familiar with ```git```, no big deal. Just download the [latest release](https://github.com/prosegrinder/pandoc-templates/releases/latest) and extract it to any directory you like.\n\n### Install via Git\n\nIf you're ```git``` savvy, clone this repository:\n\n```bash\ngit clone https://github.com/prosegrinder/pandoc-templates.git\n```\n\n## Usage\n\nOnce you have the templates installed locally, you'll need to make sure your source Markdown document\nhas the proper frontmatter.\n\n### Frontmatter\n\nThese templates assume the following frontmatter in at least one of the markdown files. The following\nis from the guidelines.md file used to test Shunn's Short Story Format:\n\n```yaml\ntitle: \"Proper Manuscript Format\"\nshort_title: \"Format\"\nauthor: \"by William Shunn\"\nauthor_lastname: \"Shunn\"\ncontact_name: \"William Shunn\"\ncontact_address: \"12 Courier Lane\"\ncontact_city_state_zip: \"Pica's Font, NY 10010\"\ncontact_phone: \"(212) 555-1212\"\ncontact_email: \"format@shunn.net\"\n```\n\nOptional properties for the frontpage:\n\n```yaml\nsubtitle: Optional field\nabstract: |-\n  Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Nam libero justo laoreet sit amet cursus. Etiam erat velit scelerisque in dictum non consectetur a. Duis tristique sollicitudin nibh sit amet commodo nulla.\n```\n\n### `md2short.sh`\n\nThe script simplifies the process of converting a short story in markdown to a Microsoft Word\nDOCX file in [William Shunn's Short Story Format](https://format.ms/story.html):\n\nFor Mac \u0026 Linux:\n\n```bash\nmd2short.sh --output DOCX [--overwrite] [--modern] FILES\n\n  -o DOCX               --output=DOCX\n    Write the output to DOCX. Passed straight to pandoc as-is.\n  -x                    --overwrite\n    If output FILE exists, overwrite without prompting.\n  -m                    --modern\n    Use Shunn modern manuscript format (otherwise use Shunn classic)\n  FILES\n    One (1) or more Markdown file(s) to be converted to DOCX.\n    Passed straight to pandoc as-is.\n```\n\nFor example:\n\n```bash\n$PANDOC_TEMPLATES_HOME/bin/md2short.sh --output $HOME/somecoolstory.docx --overwrite $HOME/somecoolstory.md\n```\n\nFor Windows (using PowerShell 5.0 or greater): **under revision**\n\n```powershell\n.\\bin\\md2short.ps1 -overwrite -modern -output $env:USERPROFILE/Documents/short-out-ps.docx './test/short/guidelines.md'\n```\n\n### `md2long.sh`\n\nThe script simplifies the process of converting a novel in markdown to a Microsoft Word\nDOCX file in [William Shunn's Novel Format](https://format.ms/novel.html):\n\nFor Mac \u0026 Linux:\n\n```bash\nmd2long.sh --output DOCX [--overwrite] FILES\n\n  -o DOCX               --output=DOCX\n    Write the output to DOCX.\n    Passed straight to pandoc as-is.\n  -x                    --overwrite\n    If output FILE exists, overwrite without prompting.\n  FILES\n    One (1) or more Markdown file(s) to be converted to DOCX.\n    Passed straight to pandoc as-is.\n```\n\nFor example:\n\n```bash\n$PANDOC_TEMPLATES_HOME/bin/md2long.sh --output $HOME/somecoolstory.docx --overwrite $HOME/manuscript/ch*.md\n```\n\nFor Windows (using PowerShell 5.0 or greater): **under revision**\n\n## Credits\n\n* [Pandoc](https://pandoc.org): Document Conversion Utility\n* [William Shunn](https://www.shunn.net/format/): Formatting Guidelines\n* [Markdown](https://daringfireball.net/projects/markdown/): A Plain Text Formatting Syntax\n\n## Contributing\n\nWhen contributing to this repository, please first open an issue to discuss the changes you wish to make.\n\nIn general:\n\n* Use the standard Pull Request process.\n* Be respectful of yourself and others.\n* Have fun!\n\n## Versioning\n\nThis project uses [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/prosegrinder/pandoc-templates/tags).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprosegrinder%2Fpandoc-templates","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fprosegrinder%2Fpandoc-templates","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprosegrinder%2Fpandoc-templates/lists"}