Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ctrekker/plutoliveexport.jl
🚀 Keep an updated export of every notebook you edit for quick viewing and publishing!
https://github.com/ctrekker/plutoliveexport.jl
Last synced: about 1 month ago
JSON representation
🚀 Keep an updated export of every notebook you edit for quick viewing and publishing!
- Host: GitHub
- URL: https://github.com/ctrekker/plutoliveexport.jl
- Owner: ctrekker
- License: mit
- Created: 2022-01-30T02:55:49.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2022-02-10T23:22:33.000Z (almost 3 years ago)
- Last Synced: 2024-11-15T16:13:48.289Z (about 2 months ago)
- Language: Julia
- Size: 9.77 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# PlutoLiveExport.jl
Keep an updated export of every notebook you edit for quick viewing and publishing! 🚀
## Installation
```julia
(@v1.7) pkg> add PlutoLiveExport
```
## Usage
Use the following code to start Pluto instead of the standard `Pluto.run` way.
```julia
using Pluto, PlutoLiveExport
Pluto.run(; on_export=live_export())
```
_Make sure to call `live_export` as a function (`live_export()`)_
By default this will automatically make exports to `~/Documents/Pluto Exports` every time you make a change in a notebook. You can change where these exports get placed by providing a path to the `export_path` keyword argument.
```julia
using Pluto, PlutoLiveExport
Pluto.run(; on_export=live_export(; export_path = "/my/export/path"))
```
## Export Configuration
The only positional argument of `live_export` is `format`, which can be used to switch export formats from the default of HTML. The currently supported export formats are:
- html
- statefile
As an example, to export to statefiles we would use `live_export("statefile")`.
> _[what's a statefile??](https://plutopublish.com/docs/statefiles.md)_
To export into multiple formats simultaneously, pass a vector of formats instead.
```julia
live_export(["html", "statefile"])
```
### Keyword Arguments
List of keyword arguments for `live_export`:
- `export_path` - Folder that exports are saved in
- _that's it for now :)_