electron / osx-sign

Codesign Electron macOS apps
BSD 2-Clause "Simplified" License
558 stars 96 forks source link

docs: clean up types and add API docs site #320

Closed erickzhao closed 1 month ago

erickzhao commented 1 month ago

This PR adds typedoc API documentation from our TypeScript types for the @electron/osx-sign package.

The module already had some pretty good API documentation available on the README.md, so the PR mostly moves the existing explanations around. This has the added bonus of providing better editor intellisense.

Goals:

Notes:

Preview from my fork of this repo: https://erickzhao.github.io/osx-sign/

erickzhao commented 1 month ago

Note that this PR doesn't actually set up any publishing for the website. I figured that could go into a follow-up PR where we set a GH Action similar to how electron/packager does it.

continuous-auth[bot] commented 2 weeks ago

:tada: This PR is included in version 1.3.1 :tada:

The release is available on:

Your semantic-release bot :package::rocket: