-
Notifications
You must be signed in to change notification settings - Fork 29
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
Create single page html for use on ebook readers #28
base: master
Are you sure you want to change the base?
Conversation
@@ -3,11 +3,14 @@ root = true | |||
|
|||
[*] | |||
charset = utf-8 | |||
indent_style = space | |||
#indent_style = space |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
#indent_style = space | |
indent_style = space |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
First: this PR is just a PoC/hack. I needed this change because VS Code kept corrupting my makefiles, where the rule blocks are mandatorily starting with a single tab indent. I spent a few minutes trying to work this out, then simply issued this, as my goal was not fixing the VS Code editorconfig/makefile support, but generating beancount docs.
The problem root cause might be fixed upstream already.
rounding_precision_in_beancount.md \ | ||
beancount_v3.md \ | ||
installing_beancount_v3.md \ | ||
beancount_v3_dependencies.md |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is it possible to read the chapter list from index.json?
Maybe this makefile can be replaced with a shorter python script
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great catch!
Also I agree about the short py script, I just needed to get stuff done. I will have some time a few weeks later, I'll try to get back to this, but also fell free to improve/reimplement it, if you have capacity.
Thanks for the valuable feedback, and ideas!
@kodfodrasz How do you think it should be deployed / published? |
@xuhcc I'm afraid it is not in that quality yet. At least I should add some README to make it usable for others. If you think the feature is useful, and should be added to the docs repo, then I'll clean this up, and add some docs to it. I'd stick to pandoc, but instead of make+shell tools I'd rewrite it with python to align with the rest of the repo/project. |
Yes I think it's useful. I think we can publish it along with the rest of the documentation site to https://beancount.github.io/docs/ |
Hi!
A version suitable for ebook readers, eg. a single page HTML, or an epub file would be great.
I have created a proof of concept, which I could transfer to my kindle using Calibre, and seems to work fine.
It is done as a quick hack, with the tools I'm familiar with, just sharing it as a conversation starter. Maybe it could be done even simpler using pandoc better, I have just used it for the first time :)
now I just need pandoc and gnu make installed, and issue
make
in the ebook folder.