PlotDocs.jl

Documentation for Plots.jl

Editing the Docs

To edit the documentation, simply edit the Markdown files in docs/src. Documenter.jl will automatically rebuild the documentation when changes are merged to master. The new documentation files will be pushed to the gh-pages branch in this repository (useful for debugging the Plots.jl documentation build through CI).

Building the docs

With proper dependencies installed, run GKSwstype=nul julia --project=docs/ docs/make.jl.

Contributing demos

The demos are valid julia scripts written with Literate markup syntax and managed by DemoCards.jl. The following steps shows a common workflow to add demos:

1. create your julia script in any sub-folder in docs/user_gallery/. For instance, docs/user_gallery/misc/gr_lorenz_attractor.jl.
2. configure the demo using DemoCards YAML frontmatter. You may also check how other demos are configured as a reference.
3. write the demo in Julia with the Literate markup syntax.
4. preview the demo using DemoCards.preview_demos feature. For instance, you can partially build one single file via preview_demos("docs/user_gallery/misc/gr_lorenz_attractor.jl"), or the entire section via preview_demos("docs/user_gallery/misc"), or even the entire page via preview_demos("docs/user_gallery").

The demo dependencies are managed by docs/Project.toml. To ensure reproducibility, you should run the demo in the docs environment, e.g., start your julia with julia --project=docs.