Hey, folks. I hope this is the right place to reach out to the Homebrewery dev team. I have a tool for building PDF books from Markdown sources, and I have built some Homebrewery-related extensions for it:
- A style fork of Homebrewery that is compatible with print media as well as the HTML renderer we are using.
- A plugin to my tool that will parse the Homebrewery markdown extensions into "Markdown in HTML" extension compatible Markdown that we can parse with the tool.
I would like to open source all of the above, but I wanted to check in for the Homebrewery-specific stuff and see if that's okay with you and/or if you need any specific form of attribution besides a link and general acknowledgment.
Thanks!
@caesuric The Homebrewery is licensed using the MIT License. Which means you are free to use The Homebrewery or any parts of the codebase any way that you want, except for claiming that you made it yourself, and provided that you include a copy of the license somewhere in your project where others can see it (even as a comment in the code is fine , just so people can trace it back to us somehow).
@calculuschild Awesome, thank you for the clarification. I believe I am familiar with the legal obligations of the license, I was more just checking for things you'd like/appreciate beyond the things I'm legally required to do . Feel free to let me know if doing this in any particular way would be helpful for you. :)
@caesuric You could always make a shout-out to us whenever you advertise it. Point people to our Patreon page, etc. Maybe let us know when you release it so we can check it out! But really we don't expect anything else. Depending how your project functions, we could potentially create some kind of collaboration and add your extension as an official Homebrewery component if you would be amenable to that. Lots of people are creating new CSS themes, tweaks in their own forks, etc. and occasionally we reach out and ask if we can incorporate their work into the official project. Open-source is nice when it goes both ways, if that makes sense.
(Depending on your server setup, there could potentially be some benefit to having a PDF download feature that isn't reliant on browser rendering and allows PDF anchor links within documents (which the stack I am using allows). It's not perfect at handling certain things yet (mainly large block elements and column balancing), but it is still a work in progress and I hope to solve those eventually. Though I guess there may also be a bandwidth consideration for you if you integrated such a thing.)
The one issue we face is that with user-generated content (Markdown) there is always a chance that someone comes up with a nasty input that results in some evil Regex and can tie up a lot of server memory or leave us open to certain attacks. We try to have all Markdown processing handled on the client end for that reason.
That said, if it's possible to run your tool in-browser, it might help with getting more uniform results across the different browsers (Chrome print-to-PDF is slightly different than Firefox, etc.), and possibly save users some confusion when they go to retrieve a PDF and instead of a download link they get the Print dialog.
Just update the Dockerfile to match the version of Node in Package.json
@calculuschild just made the project(s) public! You may be interested in the tweaks needed to get Homebrewery's style working with paged media without explicit page breaks, possibly.
libris (multiple MD -> PDF tool) here: https://github.com/lazy-scrivener-games/libris
Homebrewery style fork here: https://github.com/lazy-scrivener-games/homebrewery-fork-for-libris
pipe for pasting Homebrewery flavored markdown directly into libris input files here: https://github.com/lazy-scrivener-games/homebrewery-to-libris
libris (multiple MD -> PDF tool) here: https://github.com/lazy-scrivener-games/libris
Homebrewery style fork here: https://github.com/lazy-scrivener-games/homebrewery-fork-for-libris
pipe for pasting Homebrewery flavored markdown directly into libris input files here: https://github.com/lazy-scrivener-games/homebrewery-to-libris
I might have to install Docker, just to confirm the changes actually work before committing a PR.
I've just opened PR #1771, which is some initial work at including CodeMirror's editor themes in Homebrewery. If I've done anything the awkward/difficult way, please let me know the simple solution!
@G-Ambatte I might recommend using a package like less-plugin-glob as a less plugin rather than shuffling around files everywhere
then you can just use
@import (less) 'codemirror/theme/*'; in the codeEditor.less to import all the files.
Alternatively, do copy the cm themes over to
\buildbut don't bother manually stitching them together. Instead just swap the css file in and out on the editor as needed like we do with the brew themes in https://github.com/naturalcrit/homebrewery/blob/732021f5a5ab190752eacf76a178c7b5bc256c07/client/homebrew/brewRenderer/brewRenderer.jsx#L202 .
In #206, stolksdorf explicitly states that Docker will no longer be supported.
It does appear that the Docker install is running Homebrewery using Yarn, rather than NPM. Not entirely sure what difference that makes, just an interesting point of note.
So, a header affixed to the top of the window, the footer to the bottom, and then any number of columns in between, with excess columns available via scrolling to the right?
Slept on it, found an actually useful intro to flex, coded this: https://codepen.io/ericscheid/pen/mdMwyEE .. almost exactly what I want =)
Sending out our latest changes live as v3.0.3 now.
either no vertical black line between undo/redo and the editors, or there should be no padding between the highlight gray and the black line
Also, there is a reddit post about certain pages not showing in Chrome's print dialog, despite showing in the preview window. Here is a Share link to a Clone for their brew. I believe it is happening because the table is too long for the page, though in the past I think it would have just run off the page and be clipped...but now it's just removing the whole table. I could be misremembering that though.