Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make README.md more clear on categories display #1760

Merged
merged 1 commit into from
Sep 24, 2018
Merged

Make README.md more clear on categories display #1760

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,8 @@ Unrecognized options will be ignored. Supported options:

* **categories**: More details for each category/topic. For topics you'd like to document, specify
the markdown file with `markdown:` to use for the category page. Optionally, rename the
category from the source code into a display name with 'name:'.
category from the source code into a display name with 'name:'. If there is no matching category
defined in dartdoc_options.yaml, those declared categories in the source code will be invisible.
* **categoryOrder**: Specify the order of topics for display in the sidebar and
the package page.
* **exclude**: Specify a list of library names to avoid generating docs for,
Expand Down Expand Up @@ -157,8 +158,8 @@ as POSIX paths. Dartdoc will convert POSIX paths automatically on Windows.
You can tag libraries or top level classes, functions, and variables in their documentation with
the string `{@category YourCategory}`. For libraries, that will cause the library to appear in a
category when showing the sidebar on the Package and Library pages. For other types of objects,
the `{@category}` will be shown with a link to the category page if specified in
dartdoc_options.yaml, as above.
the `{@category}` will be shown with a link to the category page **but only if specified in
dartdoc_options.yaml**, as above.

```dart
/// Here is my library.
Expand Down