From b88db58b055a8f8e905fb7e058fa46de442740f9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jos=C3=A9=20Valim?= Date: Wed, 20 Oct 2021 15:40:00 +0200 Subject: [PATCH] Update CHANGELOG --- CHANGELOG.md | 13 +++++++++++++ lib/mix/tasks/docs.ex | 7 ++++--- 2 files changed, 17 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 4e3fe1fb9..a90bf2567 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,18 @@ # Changelog +## v0.25.4 (2021-10-20) + + * Enhancements + * Add source link to extra pages + * Add "Run in Livebook" badge to LiveMarkdown extra pages + + * Bug fixes + * Do not generate entries for private Erlang functions + * Do not trim `?` and `!` from Elixir tokens on search + + * Incompatible changes + * Remove unused `:source_root` option + ## v0.25.3 (2021-09-21) * Enhancements diff --git a/lib/mix/tasks/docs.ex b/lib/mix/tasks/docs.ex index f7a35be90..f2ff9293d 100644 --- a/lib/mix/tasks/docs.ex +++ b/lib/mix/tasks/docs.ex @@ -80,9 +80,10 @@ defmodule Mix.Tasks.Docs do * `:extra_section` - String that defines the section title of the additional Markdown and plain text pages; default: "PAGES". Example: "GUIDES" - * `:extras` - List of keywords, each key must indicate the path to additional - Markdown or plain text pages, the value for each keyword (optional) gives you more control - about the PATH and the title of the output files; default: `[]`. Example: + * `:extras` - List of paths to additional Markdown (`.md` extension), Live Markdown + (`.livemd` extension), and plain text pages to add to the documentation. You can + also specify keyword pairs to customize the generated filename and title of each + extra page; default: `[]`. Example: `["README.md", "LICENSE", "CONTRIBUTING.md": [filename: "contributing", title: "Contributing"]]` * `:filter_prefix` - Include only modules that match the given prefix in