Skip to content

Commit 64d85dd

Browse files
committed
Split customizing extras section apart
1 parent b973cfc commit 64d85dd

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

lib/mix/tasks/docs.ex

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -372,14 +372,22 @@ defmodule Mix.Tasks.Docs do
372372
373373
## Customizing Extras
374374
375+
There are two sources for extras, filenames and urls.
376+
377+
For filenames, the allowed configuration is:
378+
375379
* `:title` - The title of the extra page. If not provided, the title will be inferred from the filename.
376380
* `:filename` - The name of the generated file. If not provided, the filename will be inferred from
377381
the source file.
378382
* `:source` - The source file of the extra page. This is useful if you want to customize the filename or
379383
title but keep the source file unchanged.
380384
* `:search_data` - A list of terms to be indexed for autocomplete and search. If not provided, the content
381385
of the extra page will be indexed for search. See the section below for more.
382-
* `:url` - An external url to link to from the sidebar.
386+
387+
For urls:
388+
389+
* `:title` - The title of the extra page. If not provided, the title will be inferred from the extra name.
390+
* `:url` - The external url to link to from the sidebar.
383391
384392
### Customizing Search Data
385393

0 commit comments

Comments
 (0)