docs: use typedoc+markdown plugin for docs.page compatible reference #1175
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
|
To view this pull requests documentation preview, visit the following URL: docs.page/invertase/notifee~1175 Documentation is deployed and generated using docs.page. |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1175 +/- ##
=======================================
Coverage 77.08% 77.08%
=======================================
Files 32 32
Lines 1727 1727
Branches 556 579 +23
=======================================
Hits 1331 1331
Misses 395 395
Partials 1 1 |
mikehardy
force-pushed
the
@mikehardy/typedoc
branch
3 times, most recently
from
6ed9bcd to
1e083ac
Compare
- use mdx file extension since that's what docs.page expects - use flat output so relative links don't have pathing issues on docs.page - use main branch vs git revision in source links - set entry file name to `index` - add custom `@platform` typedoc comment - bend generated internal links to match docs.page URL auto-linking path components - strip .mdx from end of URL path - add prefix path components
mikehardy
force-pushed
the
@mikehardy/typedoc
branch
from
1e083ac to
232b864
Compare
this should keep the API reference in sync with published releases without having to remember to generate it manually
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.
If this works, reference documentation could be trivial to produce