From d928e1db5206ed57e51c066dd7d3afae20734de8 Mon Sep 17 00:00:00 2001 From: Fredrik Ekre Date: Thu, 6 Dec 2018 18:59:39 +0100 Subject: [PATCH] Define and export Markdown type to use with format= in makedocs. Add CHANGELOG.md. --- CHANGELOG.md | 31 +++++++++++++++++++++++++++++++ README.md | 4 ++-- REQUIRE | 2 +- src/DocumenterMarkdown.jl | 3 +++ 4 files changed, 37 insertions(+), 3 deletions(-) create mode 100644 CHANGELOG.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..47684b3 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,31 @@ +# DocumenterMarkdown.jl changelog + +## Version `v0.2.0` + +* ![Enhancement][badge-enhancement] Now defines and exports the `Markdown` type + which should be passed to Documenter's `makedocs` as `makedocs(format = Markdown(), ...)` + for specifying Markdown output ([#3][github-3]). + +## Version `v0.1.0` + +* Initial release. + + +[github-3]: https://github.com/JuliaDocs/DocumenterMarkdown.jl/pull/3 + + +[badge-breaking]: https://img.shields.io/badge/BREAKING-red.svg +[badge-deprecation]: https://img.shields.io/badge/deprecation-orange.svg +[badge-feature]: https://img.shields.io/badge/feature-green.svg +[badge-enhancement]: https://img.shields.io/badge/enhancement-blue.svg +[badge-bugfix]: https://img.shields.io/badge/bugfix-purple.svg + + diff --git a/README.md b/README.md index def216b..84e4d36 100644 --- a/README.md +++ b/README.md @@ -17,13 +17,13 @@ pkg> add DocumenterMarkdown ## Usage -To enable the backend import the package in `make.jl` and then just pass `format = :markdown` +To enable the backend import the package in `make.jl` and then just pass `format = Markdown()` to `makedocs`: ```julia using Documenter using DocumenterMarkdown -makedocs(format = :markdown, ...) +makedocs(format = Markdown(), ...) ``` [documenter]: https://github.com/JuliaDocs/Documenter.jl diff --git a/REQUIRE b/REQUIRE index 1719268..f965091 100644 --- a/REQUIRE +++ b/REQUIRE @@ -1,2 +1,2 @@ julia 0.7 -Documenter 0.20 +Documenter 0.21 diff --git a/src/DocumenterMarkdown.jl b/src/DocumenterMarkdown.jl index 8c0b0c1..1aa1c6d 100644 --- a/src/DocumenterMarkdown.jl +++ b/src/DocumenterMarkdown.jl @@ -2,6 +2,9 @@ module DocumenterMarkdown using Documenter +const Markdown = Documenter.Writers.MarkdownWriter.Markdown +export Markdown + function __init__() if !isdefined(Documenter.Writers, :enable_backend) @warn """Incompatible Documenter version.