Repository files navigation

A documentation generator for Julia.

Documentation	Build Status

The package can be installed with the Julia package manager.From the Julia REPL, type] to enter the Pkg REPL mode and run:

pkg> add Documenter

Or, equivalently, via thePkg API:

julia>import Pkg; Pkg.add("Documenter")

• STABLE —documentation of the most recently tagged version.
• DEVEL —documentation of the in-development version.

The package is tested against, and being developed for, Julia1.6 and above on Linux, macOS, and Windows.

Usage questions can be posted on theJulia Discourse forum under thedocumenter tag, in the #documentation channel of theJulia Slack and/or in theJuliaDocs Gitter chat room.

Contributions are very welcome, as are feature requests and suggestions. Please open anissue if you encounter any problems. Thecontributing page has a few guidelines that should be followed when opening pull requests and contributing code.

There are several packages that extend Documenter in different ways. The JuliaDocs organization maintains:

• DocumenterCitations.jl
• DocumenterInterLinks.jl
• DocumenterMarkdown.jl
• DocumenterTools.jl
• LiveServer.jl

Other third-party packages that can be combined with Documenter include:

• DemoCards.jl
• Literate.jl
• QuizQuestions.jl
• DocumenterMermaid.jl
• DocumenterDiagrams.jl

Finally, there are also a few other packages in the Julia ecosystem that are similar to Documenter, but fill a slightly different niche:

• Franklin.jl
• Publish.jl
• Weave.jl