-
Notifications
You must be signed in to change notification settings - Fork 4
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
[meta/PDF output] fix links and TOC #14
Comments
As it stands, the only useful way to consume this document is on github itself (because of the clickable links) but here the sequence diagrams aren't rendered. If the UML stuff is a blocker i'd wager that those should be a seperate make step and turned into images or vector graphics before being baked into the pdf. |
I take the full markdown, open it in Obsidian, and generate a PDF. A nicer method would be to use Pandoc somehow and generate a LaTeX file, then the PDF would be beautiful. For now, I recommend reading these docs primarily in GitHub (or locally with any IDE or Markdown editor, e.g. Obsidian or VS Code), the PDF is basically a formality to stamp the document as a tangible deliverable. |
this patch fixes ssbc#14 by outputting an html file and rewriting its links. mermaid blocks are also rewritten by remark-mermaid for rendering in the browser. the generated html is wrapped to include an inline-stylesheet and mermaidjs as a script include.
this patch fixes #14 by outputting an html file and rewriting its links. mermaid blocks are also rewritten by remark-mermaid for rendering in the browser. the generated html is wrapped to include an inline-stylesheet and mermaidjs as a script include.
This isn't about the content but the presentation. I find it really distracting that the links can't be clicked leading to a lot of scrolling or fulltext search. Additionally a table of contents and proper document outline would be very helpful since it's a lot of small sections.
@staltz what do you currently use to turn it into PDF? The
tools
folder only turns it into one giant markdown document AFAICT.The text was updated successfully, but these errors were encountered: