publish documentation as a github pages website - #147
Open
kevinushey wants to merge 1 commit into
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This adds an opt-in GitHub Actions workflow that publishes the project documentation as a GitHub Pages website at https://laurikari.github.io/tre/.
doc/build-website.shassembles a small static site: it convertsREADME.mdinto an index page with pandoc, and wrapsdoc/tre-api.htmlanddoc/tre-syntax.html(which are body-only HTML fragments, presumably from the old tre.laurikari.com site template) in a minimal page template with a navigation header. The pages are styled with the existingdoc/default.css..github/workflows/pages.ymlruns the script on every push tomasterand deploys the result to GitHub Pages.No existing files are modified, and nothing is published unless GitHub Pages is enabled for the repository (see below).
Activating (requires repo admin)
master).The site will then be live at https://laurikari.github.io/tre/ and will update automatically on every push to
master.Note: if this is merged while Pages is still disabled, the deploy job will fail on each push to
master(harmless, but noisy). Either enable Pages, or disable the "Publish documentation" workflow from the Actions tab.Testing
Built locally with pandoc 3.10 and verified that all three pages (index, API reference, regexp syntax) render as complete, styled HTML documents.
Possible follow-up, if there is interest: render the agrep man page (
doc/agrep.1.in) to HTML as part of the site.