Adding pdf/epub/mobi generation from the markdown files using pandoc #67
Conversation
* Images width has been increased * lists have been fixed * header levels have been fixed
… into btcguide-master
merge upstream
….github.io into btcguide-pandoc
… into btcguide-pandoc
merge upstream
Merge upstream changes
|
Thanks @holgern! Been getting a lot of PRs on the guide so I haven't yet given this the attention it deserves but it's really cool. I want to get it working with GitHub so the script automatically generates the downloadable versions when content is updated. |
|
Hey @holgern, I spent some time playing around with this and it's pretty neat! I also cleaned up the readme/script a little bit: It appears the #s produced by this script are kind of messed up unfortunately: I played around with it for a while, but I wasn't 100% sure I'm following the lua code. |
| end | ||
|
|
||
|
|
||
| function skip_include(el) |
There was a problem hiding this comment.
Extremely confusing name, either rename to something that makes sense or add a comment
| element.src = fix_path(element.src) | ||
| return element | ||
| end | ||
| }) |
There was a problem hiding this comment.
IDK lua, but are there usually standards for indenting? This is all over the place.
| end | ||
| doc = pandoc.read(content) | ||
| else | ||
| io.stderr:write("Warning: --- was not found twice at: " .. title .. "count: " .. count) |
There was a problem hiding this comment.
The errors this prints out appear to be nonsensical:
pandoc --pdf-engine=xelatex --template=assets/templates/eisvogel.latex --highlight-style zenburn --toc -N --lua-filter _pandoc_filter/image_link.lua --lua-filter _pandoc_filter/add_title.lua -o assets/btcguide.pdf index_pandoc.md
./assets/img/setup-specter-detect-node.png ./assets/img/setup-paper-calculate-seed.png [WARNING] Duplicate link reference '[TODO]' at line 26 column 1
[WARNING] Duplicate link reference '[TODO]' at line 24 column 1
hw/python.md hw/shitcoins.md hw/encouragement.md hw/psbt.md hosted/utxo_privacy.md hosted/utxo_privacy.md hw/python.md hw/psbt.md hw/psbt.md hw/wired_airgap.md
|
|
||
| end | ||
|
|
||
| function filter_content(content) |
There was a problem hiding this comment.
Is there no way to DRY this out? This jekyll has already gotten far too complex for what it is :(
That's partially my own fault :(
| content = string.gsub(content, '%(advanced#redundant_address_verification%)', '(#verify-receive-address-advanced)') | ||
| content = string.gsub(content, '%(/backup%-wallet%)', '(#backup-wallet)') | ||
| content = string.gsub(content, '%(/backup%-wallet/seeds%)', '(#backup-seeds)') | ||
| content = string.gsub(content, '%(/backup%-wallet/public%-keys%)', '(#backup-public-keys)') |
| function Para(elem) | ||
| if #elem.content == 1 and elem.content[1].t == "Image" then | ||
| local img = elem.content[1] | ||
| if img.classes:find('markdown',1) then |
There was a problem hiding this comment.
Can this be DRY?
Also, unclear what markdownskip and these #s are (might be clear if DRY).
|
I'm still interested in proceeding. Thinks could be simplified when the header levels would be fixed directly in the markdown code. should be fixed to Should I make a new PR in which the header levers are fixed so that the LUA script could be simplified? |
merge upstream
Sorry, I'm not following what this change would do, can you give me an example page of what the before/after would look like? Is the idea that I'm jumping from 2 |
This PR adds the necessary files to generate a pdf, epub and a mobi document from the markdown sources.
It uses a template for latex and epub generation (assets/templates). batch and bash scripts to generate pdf/epub have been added. I also explained what to install to the readme file.
Instead of index.html a new main index_pandoc.md is used as main file.
lua filters are used to do the following:
I added also a github action that is run everytime a new PR is merged or something is added and does the following:
You can view how it will look like here:
https://github.com/holgern/btcguide.github.io/releases
I'm not a LUA expert (I learned LUA with this project), so the lua code is not optimal, but works :).
The pandoc github action is failing for this PR, as it cannot create a tag yet.