trustedcomputinggroup / markdown Goto Github PK

pandoc has a build script that does all the fixups the action does now. Let's refactor the action to just use that script.

Is it supposed to look like:

**start of informative comment**
my informative comment
**end of informatrive comment**

For some reason, the copyright TCG line is about a pixel or so higher than the rest of the footer material. Drives me a little nuts.

I can think of a few basic obvious features we need to support:

• Ensure that embedding images is easy and provide an example
• Support diagrams using e.g. mermaid
• Support (and provide an example) images + diagrams as figures (with a list-of-figures)
• Make the tables nicer (it's the most old-school LaTeX looking part of this template)

GitHub supports mermaid diagrams with

```mermaid

but to include the diagrams in the lists of figures we have to use

```{.mermaid caption="figure name"}

which causes GitHub not to render it anymore.

It'd be nice to have a solution that makes both happy.

This markdown:

# References

[1] Trusted Computing Group, "DICE Protection Environment," 2023. [Online].
    Available: https://trustedcomputinggroup.org.

[2] Trusted Computing Group, "DICE Certificate Profiles," 2020. [Online].
    Available: https://trustedcomputinggroup.org.

[3] Internet Engineering Task Force, "Cryptographic Message Syntax (CMS)," 2009. [Online].
    Avilable: https://www.ietf.org/rfc/rfc5652.txt

[4] Internet Engineering Task Force, "PKCS #10: Certification Request Syntax Specification Version 1.7," 2000. [Online].
    Avilable: https://www.ietf.org/rfc/rfc2986.txt

Renders like this:

A couple issues:

• Spacing is a bit tight. I'm not sure if there's a good way to artificially add more spacing
• The margin wrapping doesn't seem to be working correctly. See how the link doesn't wrap in reference 3, but the wrapping does work in reference 4

It might aid in review processes to have a flavor of the action that generates a "PDF diff-doc" with the removed content in red, added content in green. Example: https://github.com/davidar/pandiff

This action could be automatically run on pull requests, giving reviewers a chance to easily see changes to large documents. It could also be used to prepare external review request materials.