-
-
Notifications
You must be signed in to change notification settings - Fork 1.7k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore(docs): migrating to
typedoc
and upgrading mkdocs
+material
…
… packages (#8491) Huge lift to get the documentation site in a much better state. Upgrading `mkdoc` and related theme packages. Migrated to `typedoc` for a variety of reasons, most notably that it can provide more info of properties when rendered (such as `@deprecated` messages) Migrates `docs` dir to `pages` as template documents. We copy this over to `docs` before generating `.md` with typedoc into `docs` dir. This is all automatically handled when we run `pnpm docs:all` (if local) or `sh ./netlify-docs.sh` (if netlify) Dynamically inserts `.md` files via `{% includes <path> %}` tags to streamline maintaining parity with released state of typedoc. Adjusts CSS to allow full width of browser window to be used (better readability of docs)
- Loading branch information
Showing
136 changed files
with
2,052 additions
and
8,968 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
--- | ||
"app-builder-lib": patch | ||
"builder-util": patch | ||
"builder-util-runtime": patch | ||
"dmg-builder": patch | ||
"electron-builder": patch | ||
"electron-builder-squirrel-windows": patch | ||
"electron-forge-maker-appimage": patch | ||
"electron-forge-maker-nsis": patch | ||
"electron-forge-maker-nsis-web": patch | ||
"electron-forge-maker-snap": patch | ||
"electron-publish": patch | ||
"electron-updater": patch | ||
--- | ||
|
||
chore: migrating to typedoc and updating/improving type+interface definitions |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.