Update CHANGELOG

elixir-lang · Oct 20, 2021 · b88db58 · b88db58
1 parent 850c3b8
commit b88db58
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 3 deletions.
diff --git 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
@@ -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