|
1 | 1 | # dartdoc |
2 | 2 |
|
3 | | -[](https://travis-ci.org/dart-lang/dartdoc) |
4 | | -[](https://ci.appveyor.com/project/devoncarew/dartdoc) |
| 3 | +[](https://github.com/dart-lang/dartdoc/actions?query=workflow%3ATest) |
5 | 4 | [](https://coveralls.io/github/dart-lang/dartdoc?branch=master) |
6 | 5 |
|
7 | 6 |
|
@@ -93,13 +92,13 @@ authoring doc comments for Dart with `dartdoc`. |
93 | 92 | ### dartdoc_options.yaml |
94 | 93 |
|
95 | 94 | Creating a file named dartdoc_options.yaml at the top of your package can change how Dartdoc |
96 | | -generates docs. |
| 95 | +generates docs. |
97 | 96 |
|
98 | 97 | An example (not necessarily recommended settings): |
99 | 98 |
|
100 | 99 | ```yaml |
101 | 100 | dartdoc: |
102 | | - categories: |
| 101 | + categories: |
103 | 102 | "First Category": |
104 | 103 | markdown: doc/First.md |
105 | 104 | name: Awesome |
@@ -171,7 +170,7 @@ Unrecognized options will be ignored. Supported options: |
171 | 170 | * **uriTemplate**: A template to substitute revision and file path information. If revision |
172 | 171 | is present in the template but not specified, or if root is not specified, dartdoc will |
173 | 172 | throw an exception. To hard-code a revision, don't specify it with `%r%`. |
174 | | - |
| 173 | + |
175 | 174 | The following strings will be substituted in to complete the URL: |
176 | 175 | * `%f%`: Relative path of file to the repository root |
177 | 176 | * `%r%`: Revision |
@@ -200,7 +199,7 @@ dartdoc_options.yaml**, as above. |
200 | 199 |
|
201 | 200 | ```dart |
202 | 201 | /// Here is my library. |
203 | | -/// |
| 202 | +/// |
204 | 203 | /// {@category Amazing} |
205 | 204 | library my_library; |
206 | 205 | ``` |
@@ -325,7 +324,7 @@ The `macos`, `linux`, and `windows` tags are used to describe the commands to be |
325 | 324 | run on each of those platforms, and the `setup_macos`, `setup_linux`, and |
326 | 325 | `setup_windows` tags define setup commands for their respective platforms. |
327 | 326 |
|
328 | | -The `description` is just a short description of the tool for use as help text. |
| 327 | +The `description` is just a short description of the tool for use as help text. |
329 | 328 |
|
330 | 329 | Only tools which are configured in the `dartdoc_options.yaml` file are able to |
331 | 330 | be invoked. |
@@ -473,7 +472,7 @@ Some examples of likely triage priorities: |
473 | 472 | * Minor display warts not significantly impeding navigation, not widespread |
474 | 473 | * Generation problems that should be detected but aren't warned, not |
475 | 474 | widespread |
476 | | - * Default-on warnings that are misleading or wrong, few or on edge cases |
| 475 | + * Default-on warnings that are misleading or wrong, few or on edge cases |
477 | 476 | * Non-default warnings that are misleading or wrong, widespread |
478 | 477 | * Enhancements considered important but without significant data indicating |
479 | 478 | they are a big win |
|
0 commit comments