Skip to content

Commit fc1b071

Browse files
authored
Revise README for clarity and AI disclosure
Updated README to clarify embedding of Pluto notebooks and added AI disclosure.
1 parent 0f24ff9 commit fc1b071

1 file changed

Lines changed: 10 additions & 10 deletions

File tree

‎README.md‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,8 @@
33
[![Build Status](https://github.com/JuliaPluto/DocumenterPluto.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/JuliaPluto/DocumenterPluto.jl/actions/workflows/CI.yml?query=branch%3Amain)
44
[![Docs](https://img.shields.io/badge/docs-dev-blue.svg)](https://JuliaPluto.github.io/DocumenterPluto.jl/dev/)
55

6-
A [Documenter.jl](https://documenter.juliadocs.org) plugin that embeds
7-
[Pluto.jl](https://plutojl.org) notebooks directly into an HTML documentation
8-
build — no iframes, live and interactive.
6+
A [Documenter.jl](https://documenter.juliadocs.org) plugin to embed
7+
[Pluto.jl](https://plutojl.org) notebooks inside documenter pages. This package embeds the Pluto notebook directly, without iframe.
98

109
## Requirements
1110

@@ -18,20 +17,22 @@ build — no iframes, live and interactive.
1817
```julia
1918
# docs/make.jl
2019
using Documenter
21-
using DocumenterPluto # loading is enough — no configuration
20+
using DocumenterPluto # `using DocumenterPluto` will set up Pluto support in pages
2221

2322
makedocs(sitename = "MyPackage.jl")
2423
```
2524

2625
Then in any Markdown page:
2726

2827
````markdown
28+
Here is a **Pluto notebook**:
29+
2930
```@pluto
3031
notebook = "notebooks/intro.jl"
3132
```
3233
````
3334

34-
Or with a hosted notebook:
35+
You can also embed notebooks that are pre-rendered, if they are hosted somewhere else:
3536

3637
````markdown
3738
```@pluto
@@ -48,14 +49,13 @@ for the full option reference and a live demo.
4849
DocumenterPluto hooks into Documenter's expansion and build pipelines:
4950

5051
1. An `@pluto` code block is parsed into a `PlutoBlock` AST node.
51-
2. A build step walks all pages, runs any locally-referenced notebooks through
52+
2. A build step finds all notebooks, runs them using
5253
Pluto (`Pluto.SessionActions.open` + `Pluto.notebook_to_js` + `Pluto.pack`),
5354
and copies the notebook + `.plutostate` into `docs/build/pluto_notebooks/`.
54-
3. The same step injects Pluto's frontend `<head>` assets globally via
55+
3. Pluto's frontend `<head>` assets are injected globally via
5556
[`Documenter.HTMLWriter.RawHTMLHeadContent`](https://github.com/JuliaDocs/Documenter.jl/pull/2726).
5657
4. Each `PlutoBlock` is rendered as a `<script data-pluto-file="launch-parameters">`
5758
plus a `<pluto-editor>` placeholder that the frontend hydrates on load.
5859

59-
## License
60-
61-
MIT.
60+
## AI disclosure
61+
The design for this package and the required Documenter.jl PRs were made by Fons. The implementation of this package and some of the documentation is generated using AI.

0 commit comments

Comments
 (0)