I’m pleased to announce the (very early) 0.1 release of Publish.jl. An experimental package in the same ecosystem “space” as Documenter.jl. It’s purpose is to explore alternative design decisions (potentially major and breaking ones) to those that we’ve taken over the years with Documenter, with the hopes to eventually upstream/integrate them in some way with the rest of the ecosystem.
What Publish.jl aims to provide?
- Declarative configurations rather than build scripts.
- Fully compliant commonmark parsing (plus useful extensions).
- Cross-references across packages (awaiting a suitable syntax before finishing implementing).
- General enough to be used not just for “package documentation”, but any kind of writing.
- Full style and template customisation exposed to the user.
- PDF output without having to manage any kind of LaTex environment.
- Integrated project watching with LiveServer.jl.
- And anything else we want, we’re greedy…
How far along is it?
I’ve used it build it’s own package documentation in it’s entirety, so in that sense it’s already usable. Styling is still bare-bones with the built in templates, but those are easily replaceable by users and future improvements for the defaults are planned.
How to try it?
pkg> add Publish julia> using Publish julia> serve(Publish) # start server to serve Publish's docs.
The package docs go into much more depth on what’s available at the moment.
Please open an issue, it’s very likely there’ll be stuff that’s boken/not implemented currently.