Skip to content

Latest commit

 

History

History
54 lines (37 loc) · 2.02 KB

README.md

File metadata and controls

54 lines (37 loc) · 2.02 KB
Raw

DocumenterMarkdown

Build Status

This package provides a Markdown / MkDocs backend to Documenter.jl.

Package status: Currently, the package does not work with the 0.28 branch of Documenter, and therefore the latest versions of Documenter do not have a Markdown backend available. Older, released versions of this package can still be used together with older versions of Documenter (0.27 and earlier) to enable the Markdown backend built in to those versions of Documenter.

Right now, this package is not actively maintained. However, contributions are welcome by anyone who might be interested in using and developing this backend.

Documentation

  • DEVEL — documentation of the in-development version.

Installation

The package can be added using the Julia package manager. From the Julia REPL, type ] to enter the Pkg REPL mode and run

pkg> add DocumenterMarkdown

Usage

To enable the backend import the package in make.jl and then just pass format = Markdown() to makedocs:

using Documenter
using DocumenterMarkdown
makedocs(format = Markdown(), ...)