chore(docs): migrating to typedoc and upgrading mkdocs+material packages
#8491
Conversation
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
…terial ui packages
🦋 Changeset detectedLatest commit: 557188f The changes in this PR will be included in the next version bump. This PR includes changesets to release 12 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
✅ Deploy Preview for car-park-attendant-cleat-11576 ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
mmaietta
force-pushed
the
typedoc-implementation
branch
from
ffaa35b
to
e274206
Compare
update relative links to new folder `pages` structure add additional readme intro fixing links
mmaietta
force-pushed
the
typedoc-implementation
branch
from
caecc29
to
d2ea966
Compare
additional mkdocs plugins fix sponsor images add changeset update docs with embedded interfaces update schema with proper markdown file links update snapshot
mmaietta
force-pushed
the
typedoc-implementation
branch
from
16eeed6
to
83f90dd
Compare
Merged
xyloflake
pushed a commit
to xyloflake/electron-builder
that referenced
this pull request
Oct 2, 2024
… packages (electron-userland#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)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Huge lift to get the documentation site in a much better state.
Upgrading
mkdocand related theme packages. Migrated totypedocfor a variety of reasons, most notably that it can provide more info of properties when rendered (such as@deprecatedmessages)Migrates
docsdir topagesas template documents. We copy this over todocsbefore generating.mdwith typedoc intodocsdir. This is all automatically handled when we runpnpm docs:all(if local) orsh ./netlify-docs.sh(if netlify)Dynamically inserts
.mdfiles 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)