Skip to content

Commit

Permalink
fixup(links): fix broken docusaurus v3 links (v4.9)
Browse files Browse the repository at this point in the history
it appears that in docusaurus v3.0.0 + v3.0.1, links that have a newline
in their public-facing name are considered broken. for the purposes of
the migration, we just remove the newline and unwrap lines that
docusaurus was reporting on `docusaurus build`
  • Loading branch information
rwaskiewicz authored and jaredcbaum committed Jan 2, 2024
1 parent 9b05a95 commit 9dcd32a
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 8 deletions.
6 changes: 2 additions & 4 deletions versioned_docs/version-v4.9/components/form-associated.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,8 +56,7 @@ named
method on `HTMLElement` to associate your Stencil component with an ancestor
`<form>` element. During compilation, Stencil will generate code that calls
this method at an appropriate point in the component lifecycle for both
[lazy](../output-targets/dist.md) and [custom
elements](../output-targets/custom-elements.md) builds.
[lazy](../output-targets/dist.md) and [custom elements](../output-targets/custom-elements.md) builds.
:::

A Stencil component using this API to implement a custom text input could look
Expand Down Expand Up @@ -296,5 +295,4 @@ subject](https://web.dev/articles/more-capable-form-controls#restoring-form-stat
- [ElementInternals and Form-Associated Custom Elements](https://webkit.org/blog/13711/elementinternals-and-form-associated-custom-elements/) from the WebKit blog
- [Web.dev post detailing how form-associated lifecycle callbacks work](https://web.dev/articles/more-capable-form-controls#lifecycle_callbacks)

[^1]: See <https://caniuse.com/?search=attachInternals> for up-to-date adoption
estimates.
[^1]: See https://caniuse.com/?search=attachInternals for up-to-date adoption estimates.
3 changes: 1 addition & 2 deletions versioned_docs/version-v4.9/guides/forms.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,8 +88,7 @@ export class MyName {
}
```

For more check out the docs for [form-association in
Stencil](../components/form-associated.md).
For more check out the docs for [form-association in Stencil](../components/form-associated.md).

## Advanced forms

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -165,8 +165,7 @@ For Stencil v4 the information included in the output of the `docs-json` output
target was expanded to include more information about the types of properties
and methods on Stencil components.

For more context on this change, see the [documentation for the new
`supplementalPublicTypes`](../documentation-generation/docs-json.md#supplementalpublictypes)
For more context on this change, see the [documentation for the new `supplementalPublicTypes`](../documentation-generation/docs-json.md#supplementalpublictypes)
option for the JSON documentation output target.

### `JsonDocsEvent`
Expand Down

0 comments on commit 9dcd32a

Please sign in to comment.