docs: clean up types and add API docs site #199
Conversation
erickzhao
changed the title
|
|
||
| If you are using Electron 11 or below, you must add the `com.apple.security.cs.allow-unsigned-executable-memory` entitlement too. | ||
| When using version 12+, this entitlement should not be applied as it increases your app's attack surface. | ||
| > [!NOTE] |
There was a problem hiding this comment.
What is the purpose of the [!NOTE] here? Is it suppose to style the block below? I think it looks a little strange in the preview https://erickzhao.github.io/notarize/#md:prerequisites
There was a problem hiding this comment.
It stylizes the GitHub README (https://github.com/orgs/community/discussions/16925)
TypeDoc doesn't support it, but I figured one is better than none.
| ``` | ||
|
|
||
| Another option is that you can add a new keychain item using either the Keychain Access app or from the command line using the `security` utility: | ||
| > [!IMPORTANT] |
There was a problem hiding this comment.
Similar question as above - seems to render funny in the preview
| @@ -9,102 +9,174 @@ Electron Notarize | |||
| ## Installation | |||
|
|
|||
| ```bash | |||
| # npm | |||
| npm install @electron/notarize --save-dev | |||
There was a problem hiding this comment.
Just curious, why was the yarn command removed?
There was a problem hiding this comment.
We did this recently for Forge but with the fragmentation of the JavaScript package manager ecosystem (npm, yarn 1, yarn 2+, pnpm, bun), it's easier for us to just keep the default command and for users who use alternative package managers to do the translation on their end instead.
| When notarizing your application, you may run into issues with validating your notarization | ||
| credentials. |
There was a problem hiding this comment.
Is the preview link https://erickzhao.github.io/notarize/#md:prerequisites stale? I don't see this text and the text below in the preview
There was a problem hiding this comment.
Oh, it is, sorry. I generated it against the original commit in this PR but added this text in 88b0302.
|
🎉 This PR is included in version 2.4.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
Similar to electron/osx-sign#320 but for notarize.
Significant changes:
NotarizeStapleOptionswhich is functionally identical toNotaryToolNotarizeAppOptions.See preview: https://erickzhao.github.io/notarize/