Skip to content

Commit

Permalink
Define and export Markdown type to use with format= in makedocs. (#3)
Browse files Browse the repository at this point in the history
Add CHANGELOG.md.
  • Loading branch information
fredrikekre authored Dec 11, 2018
1 parent edd42f8 commit 9622c9c
Show file tree
Hide file tree
Showing 4 changed files with 37 additions and 3 deletions.
31 changes: 31 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -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

<!--
# Badges
![BREAKING][badge-breaking]
![Deprecation][badge-deprecation]
![Feature][badge-feature]
![Enhancement][badge-enhancement]
![Bugfix][badge-bugfix]
-->
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion REQUIRE
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
julia 0.7
Documenter 0.20
Documenter 0.21
3 changes: 3 additions & 0 deletions src/DocumenterMarkdown.jl
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 9622c9c

Please sign in to comment.