File tree Expand file tree Collapse file tree 2 files changed +4
-1
lines changed
Expand file tree Collapse file tree 2 files changed +4
-1
lines changed Original file line number Diff line number Diff line change 11# Electron Docs Parser
22
3+ <img width =" 124 " height =" 124 " align =" right " alt =" docs-parser-logo " src =" design/logo.png " />
4+
35[ ![ Test] ( https://github.com/electron/docs-parser/actions/workflows/test.yml/badge.svg )] ( https://github.com/electron/docs-parser/actions/workflows/test.yml )
46[ ![ npm version] ( http://img.shields.io/npm/v/@electron/docs-parser.svg )] ( https://npmjs.org/package/@electron/docs-parser )
57
@@ -16,7 +18,8 @@ electron-docs-parser --dir ./
1618```
1719
1820Options:
19- * ` --useReadme ` - Assume all documentation is in the module's base ` README.md ` file
21+
22+ * ` --useReadme ` - Assume all documentation is in the module's base ` README.md ` file
2023* ` --dir ` - The base directory where documentation is located.
2124 * API documentation must be located in ` /docs/api ` within the specified base directory.
2225 * API structures documentation must be located in ` /docs/api/structures ` within the specified base directory.
You can’t perform that action at this time.
0 commit comments