{"action":"created","issue":{"url":"https://api.github.com/repos/jacebrowning/doorstop/issues/295","repository_url":"https://api.github.com/repos/jacebrowning/doorstop","labels_url":"https://api.github.com/repos/jacebrowning/doorstop/issues/295/labels{/name}","comments_url":"https://api.github.com/repos/jacebrowning/doorstop/issues/295/comments","events_url":"https://api.github.com/repos/jacebrowning/doorstop/issues/295/events","html_url":"https://github.com/jacebrowning/doorstop/issues/295","id":320375639,"node_id":"MDU6SXNzdWUzMjAzNzU2Mzk=","number":295,"title":"Discussion: Markdown with YAML header","user":{"login":"jed-frey","id":223258,"node_id":"MDQ6VXNlcjIyMzI1OA==","avatar_url":"https://avatars0.githubusercontent.com/u/223258?v=4","gravatar_id":"","url":"https://api.github.com/users/jed-frey","html_url":"https://github.com/jed-frey","followers_url":"https://api.github.com/users/jed-frey/followers","following_url":"https://api.github.com/users/jed-frey/following{/other_user}","gists_url":"https://api.github.com/users/jed-frey/gists{/gist_id}","starred_url":"https://api.github.com/users/jed-frey/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/jed-frey/subscriptions","organizations_url":"https://api.github.com/users/jed-frey/orgs","repos_url":"https://api.github.com/users/jed-frey/repos","events_url":"https://api.github.com/users/jed-frey/events{/privacy}","received_events_url":"https://api.github.com/users/jed-frey/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":6,"created_at":"2018-05-04T18:08:56Z","updated_at":"2018-06-10T22:45:44Z","closed_at":null,"author_association":"NONE","body":"Most Markdown rendering tools allow for a YAML block at the top of the markdown so that you can add metadata to the top of the markdown. Including [Jeckyll and GitHub Pages](https://blog.github.com/2013-09-27-viewing-yaml-metadata-in-your-documents/), [Pandoc](https://pandoc.org/MANUAL.html#extension-yaml_metadata_block), [Hugo](https://gohugo.io/content-management/front-matter/), [Nikola](https://getnikola.com/handbook.html#yaml-metadata), [MkDocs](http://www.mkdocs.org/), among others.\r\n\r\nFor a proof of concept I took requirement TUT017 and ['converted' it to markdown.](https://gist.githubusercontent.com/jed-frey/cf80624e70742d8333e92183be145d94/raw/f09d3d653eead487f9a48121f2e6c96a01014c26/TUT017.md)\r\n\r\nThen used Pandoc with a slightly modified [Eisvogel LaTeX](https://github.com/Voleking/pandoc-templates/blob/master/eisvogel.latex) template to produce this: [TUT017.pdf](https://github.com/jacebrowning/doorstop/files/1971566/TUT017.pdf) with:\r\n\r\n```\r\npandoc TUT017.md \\\r\n\t--to=latex \\\r\n\t--output=TUT017.pdf \\\r\n\t--standalone \\\r\n\t--template=.pandoc/templates/pdf/Eisvogel/eisvogel.tex \\\r\n\t--variable=titlepage:true\r\n```\r\n\r\nThe ```doorstop``` YAML metadata is passed through in Pandoc so custom LaTeX templates can be created for companies to generate PDF requirements documents straight from the ```doorstop``` files.\r\n\r\nSecond, it would allow using the capabilities existing markdown editors [eg, [remarkable](https://remarkableapp.github.io/), editors with markdown capabilities [eg,  [Notepad++](https://github.com/nea/MarkdownViewerPlusPlus)], or any editor that has markdown syntax highlighting [eg, [vim](https://github.com/tpope/vim-markdown)]. Right now the content is embedded as a YAML field making it easy to mess up since the YAML requires 2 spaces but any Markdown indentation for code needs 4, so code blocks have to have 6 indentations.  With Markdown rendering and syntax highlighting it should reduce mistakes in Markdown formatting."},"comment":{"url":"https://api.github.com/repos/jacebrowning/doorstop/issues/comments/396087934","html_url":"https://github.com/jacebrowning/doorstop/issues/295#issuecomment-396087934","issue_url":"https://api.github.com/repos/jacebrowning/doorstop/issues/295","id":396087934,"node_id":"MDEyOklzc3VlQ29tbWVudDM5NjA4NzkzNA==","user":{"login":"jed-frey","id":223258,"node_id":"MDQ6VXNlcjIyMzI1OA==","avatar_url":"https://avatars0.githubusercontent.com/u/223258?v=4","gravatar_id":"","url":"https://api.github.com/users/jed-frey","html_url":"https://github.com/jed-frey","followers_url":"https://api.github.com/users/jed-frey/followers","following_url":"https://api.github.com/users/jed-frey/following{/other_user}","gists_url":"https://api.github.com/users/jed-frey/gists{/gist_id}","starred_url":"https://api.github.com/users/jed-frey/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/jed-frey/subscriptions","organizations_url":"https://api.github.com/users/jed-frey/orgs","repos_url":"https://api.github.com/users/jed-frey/repos","events_url":"https://api.github.com/users/jed-frey/events{/privacy}","received_events_url":"https://api.github.com/users/jed-frey/received_events","type":"User","site_admin":false},"created_at":"2018-06-10T22:45:43Z","updated_at":"2018-06-10T22:45:43Z","author_association":"NONE","body":"@jacebrowning Suggestions where to dive into the code?"}}
{"actor":{"display_login":"jed-frey"}}