Add Github pages for reading the spec

contour-terminal / terminal-good-image-protocol

*Good* Image Protocol - a formalization of a proposal for a new image protocol for virtual terminal emulators

33 stars 2 forks source link

Open christianparpart opened 3 years ago

christianparpart commented 3 years ago

the github page should:

allow reading the spec online right from that page (maybe the markdown version and optionally a link to the PDF)?
have a link to the actual github repo
this should somehow be auto-generated via CI (Github Actions), just like currently done with the (pre-)releases

wez commented 3 years ago

I don't have bandwidth for this directly, but you could potentially leverage https://github.com/wez/wezterm/blob/main/.github/workflows/pages.yml which is the action I use to publish the wezterm docs to gh_pages using mdbook. I don't think you need mdbook for this; the key thing is the publish stage at the bottom: https://github.com/wez/wezterm/blob/main/.github/workflows/pages.yml#L44

christianparpart commented 3 years ago

Thanks for that! :)