| # fx doc-checker |
| |
| Check the markdown documentation using a variety of checks. |
| |
| ```none |
| USAGE: |
| fx doc-checker [--root <root>] [--project <project>] [--docs-folder <docs-folder>] [--local-links-only] |
| Options: |
| --root path to the root of the checkout of the project. |
| --project name of project to check, defaults to fuchsia. |
| --docs-folder (Experimental) Name of the folder inside the project which |
| contains documents to check. Defaults to 'docs'. |
| --local-links-only do not resolve http(s) links |
| --help display usage information |
| ``` |
| |
| [doc-checker source code](https://cs.opensource.google/fuchsia/fuchsia/+/main:tools/devshell/doc-checker.fx) |
