docs-parser icon indicating copy to clipboard operation
docs-parser copied to clipboard

Published 20 hours ago • verified publisher icon electron

Agnostic interest: Collection of the static, electron-specific bits of docs-parser

Open bnb opened this issue 5 years ago • 1 comments

Currently running through docs-parser to see if it could be adapted to something like Node.js's docs. Here's a set of things that I've found to be highly electron-focused:

  • Output file is by default called electron-api.json.
    • Possible resolution: default to api.json and provide a CLI flag to change the name to something custom (like electron-api.json or node-api.json).
  • Website URL is hardcoded to electronjs.org
    • Possible resolution: have a project config that can define this.
    • Possible resolution: don't include unless CLI flag is passed or a project config exists.
  • Repo URL is hardcoded to electron/electron
    • Possible resolution: have a project config that can define this.
    • Possible resolution: don't include unless CLI flag is passed or a project config exists.
  • Process property exists in the root of the JSON output where it may not be useful for anything outside of Electron.
    • Possible resolution: opt-in to including this via flag/config.

bnb avatar Dec 01 '19 13:12 bnb

Fixed in #21

MarshallOfSound avatar Dec 01 '19 22:12 MarshallOfSound