diff --git a/CHANGELOG.md b/CHANGELOG.md index 6a33ce89bb..8ffd2d8af6 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,9 @@ # Documenter.jl changelog +## Version `v0.28.0` (unreleased) + +* ![Enhancement][badge-enhancement] The `ansicolor` keyword to `HTML()` now defaults to true, meaning that executed outputs from `@example`- and `@repl`-blocks are now by default colored (if they emit colored output). ([#1828][github-1828]) + ## Version `v0.27.18` * ![Enhancement][badge-enhancement] The padding of the various container elements in the HTML style has been reduced, to improve the look of the generated HTML pages. ([#1814][github-1814], [#1818][github-1818]) @@ -1037,6 +1041,7 @@ [github-1818]: https://github.com/JuliaDocs/Documenter.jl/pull/1818 [github-1821]: https://github.com/JuliaDocs/Documenter.jl/pull/1821 [github-1825]: https://github.com/JuliaDocs/Documenter.jl/pull/1825 +[github-1828]: https://github.com/JuliaDocs/Documenter.jl/pull/1828 [julia-38079]: https://github.com/JuliaLang/julia/issues/38079 diff --git a/src/Writers/HTMLWriter.jl b/src/Writers/HTMLWriter.jl index 56d71f2979..3b5bf3d3da 100644 --- a/src/Writers/HTMLWriter.jl +++ b/src/Writers/HTMLWriter.jl @@ -347,7 +347,8 @@ passing options to the [`KaTeX`](@ref) or [`MathJax2`](@ref)/[`MathJax3`](@ref) the page navigation. Defaults to `"Powered by [Documenter.jl](https://github.com/JuliaDocs/Documenter.jl) and the [Julia Programming Language](https://julialang.org/)."`. -**`ansicolor`** can be used to enable/disable colored output from `@repl` and `@example` blocks globally. +**`ansicolor`** can be used to globally disable colored output from `@repl` and `@example` +blocks by setting it to `false` (default: `true`). **`lang`** specifies the [`lang` attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/lang) of the top-level `` element, declaring the language of the generated pages. The default @@ -428,7 +429,7 @@ struct HTML <: Documenter.Writer highlights :: Vector{String} = String[], mathengine :: Union{MathEngine,Nothing} = KaTeX(), footer :: Union{String, Nothing} = "Powered by [Documenter.jl](https://github.com/JuliaDocs/Documenter.jl) and the [Julia Programming Language](https://julialang.org/).", - ansicolor :: Bool = false, # true in 0.28 + ansicolor :: Bool = true, lang :: String = "en", warn_outdated :: Bool = true,