r
/
Literate.jl
mirror of https://github.com/fredrikekre/Literate.jl
1
0
Fork 0
Code Releases Activity
Browse Source

Add some missing changelog entries and update CHANGELOG.md 

to follow the keepachangelog.com format.
pull/161/head
Fredrik Ekre 4 years ago
parent
f42b32a93a
commit
f1fde7974e
1 changed files with 117 additions and 93 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Split View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 210
      CHANGELOG.md

210
CHANGELOG.md
Unescape View File

@ -1,81 +1,105 @@ @@ -1,81 +1,105 @@
# Literate.jl changelog
## Version `v2.8`
* ![Feature][badge-feature] Execution of notebooks now capture output of `display(x)`
and `display(mime, x)` ([ceff7a3][ceff7a3]).
## Version `v2.7`
* ![Feature][badge-feature] Multiline-style Julia comments (`#= ... =#`) can now be
used for markdown input ([dc409d0][dc409d0]).
## Version `v2.6`
* ![Feature][badge-feature] New end-of-line token `#hide` which filters out the line
*after* execution in `Literate.markdown(...; execute=true)` ([6d1aec9][6d1aec9]).
* ![Feature][badge-feature] Markdown execution now captures the `text/markdown` MIME
([e08ca0a][e08ca0a]).
## Version `v2.5`
* ![Feature][badge-feature] The output directory now defaults to `pwd()` ([2ba316a][2ba316a]).
## Version `v2.4`
* ![Feature][badge-feature] Markdown output can now be executed and the result included
in the output by pasing `execute=true` to `Literate.markdown`. Currently captures the
following MIMEs: `text/plain`, `image/png`, and `image/jpeg` ([7e89fdb][7e89fdb]).
## Version `v2.3`
* ![Feature][badge-feature] Filter tokens `#md`, `#nb`, and `#jl`, as well as their negated
counterparts, can now be placed at the end of lines ([b0806ed][b0806ed]).
## Version `v2.2`
* ![Feature][badge-feature] Configuration can now be passed as a `config::Dict`
keyword argument to the generators ([0f9e836][0f9e836]).
* ![Feature][badge-feature] Link macros now works when running on GitLab CI
([4e71b15][4e71b15]).
* ![Feature][badge-feature] Literate now supports more configuration for
e.g. URL's that `@__REPO_ROOT_URL__` and friends expand to ([4e71b15][4e71b15]).
## Version `v2.1`
* ![Feature][badge-feature] Link macros now works when running on GitHub Actions
([cf2b552][cf2b552]).
## Version `v2.0`
* ![BREAKING][badge-breaking] The link macros `@__REPO_ROOT_URL__`, `@__NBVIEWER_ROOT_URL__`
All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## [Unreleased]
### Added
- Added "Franklin flavored" markdown output for usage with [Franklin]
(https://franklinjl.org/). Enable by passing the `flavor` keyword argument:
```julia
Literate.markdown(...; flavor = Literate.FranklinFlavor())
```
([#146][github-146], [#147][github-147], [#156][github-156])
- Added "Documenter flavored" markdown output as a replacement for `documenter=true`,
and "CommonMark flavored" markdown output as a replacement for `documenter=false`.
Enable by passing the `flavor` keyword argument:
```julia
Literate.markdown(...; flavor = Literate.DocumenterFlavor())
Literate.markdown(...; flavor = Literate.CommonMarkFlavor())
```
([#159][github-159])
- Added option to use multiline markdown strings (`md""" ... """`) as markdown sections.
To enable, pass `mdstrings=true`. ([#152][github-152], [#149][github-149])
### Changed
- The default code fence for markdown output have been changed to 4 (instead of 3)
backticks to allow input files with 3 backticks, which is common in e.g.
docstrings or multiline `Cmd`. ([#144][github-144], [#145][github-145])
- Replacement of Documenter-style `@ref` and `@id` elements are now removed unconditionally
instead of conditionally based on the (now deprecated) `documenter` keyword argument.
([#159][github-159])
### Deprecated
- The `documenter` keyword argument has been deprecated. For `Literate.markdown` the
the replacement is to use `flavor = Literate.DocumenterFlavor()` or
`flavor = Literate.CommonMarkFlavor()` as appropriate (see above).
For `Literate.notebook` and `Literate.script` the option is now unused (see above
regarding `@ref` and `@id`), and no replacement is necessary. ([#159][github-159])
## [2.8] - 2021-01-19
### Added
- Execution of notebooks now capture output of `display(x)` and `display(mime, x)`
([ceff7a3][ceff7a3]).
## [2.7] - 2021-09-12
### Added
- Multiline-style Julia comments (`#= ... =#`) can now be used for markdown input
([dc409d0][dc409d0]).
## [2.6] - 2020-08-15
### Added
- New end-of-line token `#hide` which filters out the line *after* execution in
`Literate.markdown(...; execute=true)` ([6d1aec9][6d1aec9]).
- Markdown execution now captures the `text/markdown` MIME ([e08ca0a][e08ca0a]).
## [2.5] - 2020-05-14
### Changed
- The output directory now defaults to `pwd()` ([2ba316a][2ba316a]).
## [2.4] - 2020-04-23
### Added
- Markdown output can now be executed and the result included in the output by pasing
`execute=true` to `Literate.markdown`. Currently captures the following MIMEs:
`text/plain`, `image/png`, and `image/jpeg` ([7e89fdb][7e89fdb]).
## [2.3] - 2020-03-03
### Added
- Filter tokens `#md`, `#nb`, and `#jl`, as well as their negated counterparts, can now
be placed at the end of lines ([b0806ed][b0806ed]).
## [2.2] - 2019-11-26
### Added
- Configuration can now be passed as a `config::Dict` keyword argument to the generators
([0f9e836][0f9e836]).
- Link macros now works when running on GitLab CI ([4e71b15][4e71b15]).
- Literate now supports more configuration for e.g. URL's that `@__REPO_ROOT_URL__` and
friends expand to ([4e71b15][4e71b15]).
## [2.1] - 2019-10-30
### Added
- Link macros now works when running on GitHub Actions ([cf2b552][cf2b552]).
## [2.0] - 2019-07-19
### Added
- Negated filter tokens (`#!nb`, `#!md` and `#!jl`) are now supported ([1d02868][1d02868]).
- Notebook output now support cell metadata with the `%%`-format ([0872a96][0872a96]).
### Changed
- **BREAKING** The link macros `@__REPO_ROOT_URL__`, `@__NBVIEWER_ROOT_URL__`
and `@__BINDER_ROOT_URL__` no longer include a trailing `/` ([7af5414][7af5414]).
* ![BREAKING][badge-breaking] The (undocumented) feature of Documenter continued blocks now
- **BREAKING** The (undocumented) feature of Documenter continued blocks now
requires an explicit `#+` chunk splitter ([36e8c21][36e8c21]).
- The link macros `@__REPO_ROOT_URL__`, `@__NBVIEWER_ROOT_URL__` now expands to correct
paths when documentation is built with DocumentationGenerator.jl ([7af5414][7af5414]).
* ![Feature][badge-feature] Negated filter tokens (`#!nb`, `#!md` and `#!jl`) are now
supported ([1d02868][1d02868]).
* ![Feature][badge-feature] Notebook output now support cell metadata with the `%%`-format
([0872a96][0872a96]).
* ![Feature][badge-feature] The link macros `@__REPO_ROOT_URL__`, `@__NBVIEWER_ROOT_URL__`
now expands to correct paths when documentation is built with DocumentationGenerator.jl
([7af5414][7af5414]).
## Version `v1.1`
* ![Feature][badge-feature] New link macro `@__BINDER_ROOT_URL__` for linking to notebooks
mybinder.org ([fa64dcd][fa64dcd]).
## Version `v1.0`
## [1.1] - 2019-04-05
### Added
- New link macro `@__BINDER_ROOT_URL__` for linking to notebooks mybinder.org
([fa64dcd][fa64dcd]).
* First stable release of Literate.jl, see https://discourse.julialang.org/t/ann-literate-jl/10651
for release announcement.
## [1.0] - 2019-03-06
First stable release of Literate.jl, see
https://discourse.julialang.org/t/ann-literate-jl/10651 for release announcement.
[7af5414]: https://github.com/fredrikekre/Literate.jl/commit/7af541461672c3098cc99c471377f0d379839fe8
@ -94,24 +118,24 @@ @@ -94,24 +118,24 @@
[dc409d0]: https://github.com/fredrikekre/Literate.jl/commit/dc409d0f43a6282bee4e28e8e12bb6309942e5d5
[ceff7a3]: https://github.com/fredrikekre/Literate.jl/commit/ceff7a36be2a9152d853257bac97be00d915ba8e
[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
[badge-security]: https://img.shields.io/badge/security-black.svg
[badge-experimental]: https://img.shields.io/badge/experimental-lightgrey.svg
[badge-maintenance]: https://img.shields.io/badge/maintenance-gray.svg
<!--
# Badges
![BREAKING][badge-breaking]
![Deprecation][badge-deprecation]
![Feature][badge-feature]
![Enhancement][badge-enhancement]
![Bugfix][badge-bugfix]
![Security][badge-security]
![Experimental][badge-experimental]
![Maintenance][badge-maintenance]
-->
[github-144]: https://github.com/fredrikekre/Literate.jl/issues/144
[github-145]: https://github.com/fredrikekre/Literate.jl/pull/145
[github-146]: https://github.com/fredrikekre/Literate.jl/pull/146
[github-147]: https://github.com/fredrikekre/Literate.jl/pull/147
[github-149]: https://github.com/fredrikekre/Literate.jl/issues/149
[github-152]: https://github.com/fredrikekre/Literate.jl/pull/152
[github-156]: https://github.com/fredrikekre/Literate.jl/pull/156
[github-159]: https://github.com/fredrikekre/Literate.jl/pull/159
[Unreleased]: https://github.com/fredrikekre/Literate.jl/compare/v2.8.1...HEAD
[2.8]: https://github.com/fredrikekre/Literate.jl/compare/v2.7.0...v2.8.1
[2.7]: https://github.com/fredrikekre/Literate.jl/compare/v2.6.0...v2.7.0
[2.6]: https://github.com/fredrikekre/Literate.jl/compare/v2.5.1...v2.6.0
[2.5]: https://github.com/fredrikekre/Literate.jl/compare/v2.4.0...v2.5.1
[2.4]: https://github.com/fredrikekre/Literate.jl/compare/v2.3.1...v2.4.0
[2.3]: https://github.com/fredrikekre/Literate.jl/compare/v2.2.1...v2.3.1
[2.2]: https://github.com/fredrikekre/Literate.jl/compare/v2.1.1...v2.2.1
[2.1]: https://github.com/fredrikekre/Literate.jl/compare/v2.0.4...v2.1.1
[2.0]: https://github.com/fredrikekre/Literate.jl/compare/v1.1.0...v2.0.4
[1.1]: https://github.com/fredrikekre/Literate.jl/compare/v1.0.5...v1.1.0
[1.0]: https://github.com/fredrikekre/Literate.jl/tree/v1.0.5

Write Preview
Loading…
Cancel
Save