Jekyll-ify continuation

chaincodelabs / onboarding-to-bitcoin-core

The missing onboarding guide to Bitcoin Core

https://bitcoincore.academy

91 stars 37 forks source link

Jekyll-ify continuation #68

Closed willcl-ark closed 10 months ago

willcl-ark commented 10 months ago

Continuing on with the great work by @harding in #65

[x] Fix all test failures (mostly links that need to be update)
[x] Enable mermaid.js and ~~pygments~~ rouge
[x] Remove temporary QA assets used to ensure no unnecessary modifications were made to the source text
[x] Add 'edit this page on GitHub' buttons
[x] Add github action to build and deploy to GH pages
[x] Add PDF version (note: missing images due to mermaid-cli incompatibility)
[ ] Add ePub versions

willcl-ark commented 10 months ago

OK, I think I've done all that I can here.

Unfortunately we are going to struggle with making PDF and ePUB versions which include diagrams, as mermaid-cli doesn't create standards-compliant SVGs (see: https://github.com/mermaid-js/mermaid/issues/2485#issuecomment-1834033650)

We could serve copies without diagrams though, if we choose to...

On merging into master this should deploy to GH pages @ bitcoincore.academy automagically, but there's only one way to find out...

ping @adamjonas

willcl-ark commented 10 months ago

Switched to using the Makefile in the publish workflow, and added PDF book version.

Perhaps still outstanding is that two of the three homepage action cards ("Review a PR" and "Squash a bug") both link to 404's, as they're not yet implemented.

We could remove them temporarily, or complete them...

willcl-ark commented 10 months ago

Preview of this branch is here: https://willcl-ark.github.io/onboarding-to-bitcoin-core/

willcl-ark commented 10 months ago

Ok I have some form of admonition icons working now using font-awesome

willcl-ark commented 10 months ago

Let's see if the new workflow works in this repo too.