https://github.com/rikhuijzer/plutostatichtml.jl

Convert Pluto notebooks to HTML in automated workflows
https://github.com/rikhuijzer/plutostatichtml.jl

html julia julialang notebooks pluto tutorials

Last synced: about 18 hours ago
JSON representation

Convert Pluto notebooks to HTML in automated workflows

• Host: GitHub
• URL: https://github.com/rikhuijzer/plutostatichtml.jl
• Owner: rikhuijzer
• License: mit
• Created: 2021-10-27T13:16:21.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-04-16T08:32:30.000Z (5 months ago)
• Last Synced: 2024-05-01T17:44:42.493Z (5 months ago)
• Topics: html, julia, julialang, notebooks, pluto, tutorials
• Language: Julia
• Homepage: https://PlutoStaticHTML.huijzer.xyz
• Size: 1.23 MB
• Stars: 81
• Watchers: 3
• Forks: 7
• Open Issues: 14
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# PlutoStaticHTML.jl

[![Docs dev][docs-dev-img]][docs-dev-url]

[![Code Style Blue][blue-img]][blue-url]

[![Contributor's Guide on Collaborative Practices][colprac-img]][colprac-url]

A [Julia package](https://julialang.org/) to convert [Pluto notebooks](https://github.com/fonsp/Pluto.jl) to static HTML.

Unlike [PlutoSliderServer](https://github.com/JuliaPluto/PlutoSliderServer.jl), the HTML files generated using PlutoStaticHTML are very minimal, and do not require JavaScript on the user side to render.

This makes it easier to style the output using CSS.

For example, with this package it is possible to create a website full with plots generated in Julia and all code hidden.

In effect, no one would be able to tell that the website was built with Julia.

## Automated builds

Next to outputting static HTML, this package is also aimed at building multiple Pluto.jl notebooks as reliably and quickly as possible in unsupervised settings such as CI.

Therefore, this package implements:

1. Parallel evaluation of notebooks 🚀.

1. Caching of notebooks to avoid re-running code if nothing changed 🚀.

1. Throwing an error if something goes wrong.

    This avoids publishing broken notebooks 🎯.

See the [documentation](https://PlutoStaticHTML.huijzer.xyz/dev/) for more information.

[ci-url]: https://github.com/JuliaData/DataFrames.jl/actions?query=workflow%3ACI+branch%3Amain

[ci-img]: https://github.com/rikhuijzer/PlutoStaticHTML.jl/workflows/CI/badge.svg

[docs-dev-img]: https://img.shields.io/badge/docs-dev-blue.svg

[docs-dev-url]: https://PlutoStaticHTML.huijzer.xyz/dev/

[blue-img]: https://img.shields.io/badge/code%20style-blue-4495d1.svg

[blue-url]: https://github.com/invenia/BlueStyle

[colprac-img]: https://img.shields.io/badge/ColPrac-contributor's%20guide-blueviolet

[colprac-url]: https://github.com/SciML/ColPrac