docs-parser
docs-parser copied to clipboard
electron
Parse Electron docs in a lossless way into a JSON file
### Preflight Checklist - [X] I have read the [Contributing Guidelines](https://github.com/electron/electron/blob/main/CONTRIBUTING.md) for this project. - [X] I agree to follow the [Code of Conduct](https://github.com/electron/electron/blob/main/CODE_OF_CONDUCT.md) that this project adheres to. -...
This is definitely a corner case, but currently prevents this example in the docs from being typed properly: https://github.com/electron/electron/blob/ce4ae584e357000b324228693ed7556922b6335f/docs/api/client-request.md?plain=1#L54-L58 I tried single quotes rather than double quotes with the same...
Example from docs: https://github.com/electron/electron/blob/ce4ae584e357000b324228693ed7556922b6335f/docs/api/app.md?plain=1#L1137-L1141
I would like to fix this [Issue](https://github.com/electron/electron/issues/10096#issuecomment-1003426383). Especially I would like to document the `view.webContents.destroy()` method so that I can use it from typescript without having to do shenangians like...
There's been some cases in the docs where return types are listed as ``Returns `` | `` `` which gets turned into a return type of just ``, and ``...
See https://github.com/electron/electron/issues/37781 - this lead to a wildly incorrect return type of: ```ts getPreferredSystemLanguages(): Array; ```
It seems that there is currently a bug when packageMode is `multi` that nullifies descriptions of each class into a rather excessively large string. Specifically, it seems that it starts...
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...
As it stands, the requisite formatting needed to make various parts of Electron's documentation type in specific ways remains tribal. Unless you work with Electron constantly, it's not intuitive or...
At one point this module had really good test coverage, then we added a bunch of stuff to it 😆 These are mostly claude generated test cases but I've gone...
