search

webrecorder / specs

Specifications developed and maintained by the Webrecorder community.
https://specs.webrecorder.net
124 stars 15 forks source link

ReSpec generation from Markdown #143

Open edsu opened 1 year ago

edsu commented 1 year ago

While ReSpec allows Markdown to be embedded in an HTML file there doesn't appear to be an automated way to turn a standalone Markdown file into a ReSpec HTML file. It would be useful to have a Github Action that would automatically convert Markdown files when pushing content to a branch. The idea being that standalone Markdown files are easier to edit but HTML is good for publishing for readers.

edsu commented 1 year ago

I put together a Github Action for this in https://github.com/edsu/respec-action/ and configured webrecorder/specs to use it. You can see that the WACZ-IPFS spec is now presented using ReSpec:

https://specs.webrecorder.net/wacz-ipfs/latest/

I'll leave this open until the other specs have been turned into flat Markdown as well.