Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/JuliaPluto/PlutoPDF.jl
Export Pluto notebooks to PDF from the command line
https://github.com/JuliaPluto/PlutoPDF.jl
exporting-pluto-notebooks julia pluto-notebooks
Last synced: 18 days ago
JSON representation
Export Pluto notebooks to PDF from the command line
- Host: GitHub
- URL: https://github.com/JuliaPluto/PlutoPDF.jl
- Owner: JuliaPluto
- License: mit
- Created: 2021-02-18T17:52:53.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-08-28T20:04:07.000Z (3 months ago)
- Last Synced: 2024-08-28T21:36:48.556Z (3 months ago)
- Topics: exporting-pluto-notebooks, julia, pluto-notebooks
- Language: Julia
- Homepage:
- Size: 93.8 KB
- Stars: 34
- Watchers: 3
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Unmaintained
Unfortunately, PlutoPDF.jl takes too much work to maintain! So if it works on your computer, yay! Otherwise, sorry! PRs very welcome!
# PlutoPDF.jl
*Don't let your printer miss out on the fun!*
## Installation
From the Julia REPL, PlutoPDF.jl can be installed with the following:
```julia
import Pkg; Pkg.add("PlutoPDF")
```
## Usage
From within Julia:
```julia
import PlutoPDF
PlutoPDF.pluto_to_pdf("notebook.jl")
```
### Screenshots
You can also use PlutoPDF to take screenshots of all notebook cells!
```julia
import PlutoPDF
pdf_path = "notebook.pdf"
screenshots_dir = "notebook_screenshots"
PlutoPDF.pluto_to_pdf("notebook.jl", pdf_path, screenshots_dir)
```
# How it works
PlutoPDF.jl is just a combination of other software:
- Pluto: besides running notebooks, the Pluto editor is designed to look nice when printed. When you use Pluto's export to Static PDF button (top right in the editor), the button just tells the browser to open the Print window.
- Chromium web browser: Pluto has CSS styling specific for printing. But it is the browser that has the ability to take HTML and CSS and make a PDF from it.
- PlutoSliderServer: this package makes it easy to "convert `.jl` to `.html`." It can open a notebook, run it, and generate the export HTML all from the command line, so you don't need to click buttons in Pluto.
- hmmmm more info coming
# Development
When developing, it's nice to have the `node_modules` folder locally. Navigate to the `node` directory and run `npm install`.
If you don't have `npm`, then run `julia --project` and then
```julia
import PlutoPDF
PlutoPDF.build_node(joinpath(pwd(), "node"))
```