Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Electron Docs Parser

<img width="124" height="124" align="right" alt="docs-parser-logo" src="design/logo.png" />

[![Test](https://github.com/electron/docs-parser/actions/workflows/test.yml/badge.svg)](https://github.com/electron/docs-parser/actions/workflows/test.yml)
[![npm version](http://img.shields.io/npm/v/@electron/docs-parser.svg)](https://npmjs.org/package/@electron/docs-parser)

Expand All @@ -16,7 +18,8 @@ electron-docs-parser --dir ./
```

Options:
* `--useReadme` - Assume all documentation is in the module's base `README.md` file

* `--useReadme` - Assume all documentation is in the module's base `README.md` file
* `--dir` - The base directory where documentation is located.
* API documentation must be located in `/docs/api` within the specified base directory.
* API structures documentation must be located in `/docs/api/structures` within the specified base directory.
Expand Down
Binary file added design/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading