Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

actions: Switch status html rendering to pandoc #504

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

jku
Copy link
Member

@jku jku commented Jan 10, 2025

We used jekyll before: it has various issues and turned out to not be the right tool for the job -- I only used it since it was a GitHub maintained action.

  • Use pandoc (as container step) instead
  • Include a minimal CSS file to make the status page look like it's not still the 1980s
  • Prepare by copying the css file to workdir (which the pandoc container has access to)
  • Two separate build directories are now not needed (everything happens in "build/").
  • The result is now full standalone: copying the html file around should break nothing

Fixes #430.

Example in https://jku.github.io/tuf-demo/metadata/

* We used jekyll before: it has various issues
* Use pandoc (as container step) instead
* Prepare by copying the required css file to workdir
  (which the pandoc container has access to)

Two separate build directories are now not needed (everything
happens in "build/").
@jku jku requested a review from kommendorkapten as a code owner January 10, 2025 13:57
Comment on lines +53 to +54
--metadata title="TUF Repository state"
--variable title=""
Copy link
Member Author

@jku jku Jan 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this weirdness is required so

  • the html has a title that gets used in browsers as tab title, and pandoc does not complain
  • but the title is not inserted in the doc as a h1 (since we have a header already in the markdown)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

repository status page styles break when repo is moved
1 participant