docs: publish typedocs in gh-pages branch #233
Merged
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
Updates aegir to the latest version which has reinstated the `docs` command to publish typedocs in the `gh-pages` branch of repos. A `typedoc-urls.json` file is now generated as part of the docs run which allows cross-linking between module docs. This file lives at the "well known" location of `dist/typedoc-urls.json` in the published tarball, so the `files` list in `package.json` needed changing as it's currently only publishing `dist/types`.
achingbrain
changed the title
1 task
github-actions bot
pushed a commit
that referenced
this pull request
Dec 16, 2022
## [10.0.3](v10.0.2...v10.0.3) (2022-12-16) ### Documentation * publish typedocs in gh-pages branch ([#233](#233)) ([3a6d3ed](3a6d3ed))
|
🎉 This PR is included in version 10.0.3 🎉 The release is available on: Your semantic-release bot 📦🚀 |
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.
Updates aegir to the latest version which has reinstated the
docscommand to publish typedocs in thegh-pagesbranch of repos.A
typedoc-urls.jsonfile is now generated as part of the docs run which allows cross-linking between module docs.This file lives at the "well known" location of
dist/typedoc-urls.jsonin the published tarball, so thefileslist inpackage.jsonneeded changing as it's currently only publishingdist/types.See https://multiformats.github.io/js-multiaddr for an example.