Skip to content

Commit

Permalink
chore(docs): update v1 links to new repo and static hosting
Browse files Browse the repository at this point in the history
  • Loading branch information
mlaursen committed Apr 24, 2021
1 parent c691050 commit 92801bb
Show file tree
Hide file tree
Showing 6 changed files with 16 additions and 14 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Create an accessible React application with the
- [Library Size](#library-size) - The UMD bundle size for the entire `react-md`
library and sizes for some of the pre-built css files.

#### If you are still on v1, please see the [v1 documentation site](https://react-md.dev/v1) and [branch](../../tree/v1) instead
#### If you are still on v1, please see the [v1 documentation site](https://mlaursen.github.io/react-md-v1-docs/) and [branch](https://github.com/mlaursen/react-md-v1-docs) instead

<!-- rmd-readme-replace -->

Expand Down
17 changes: 9 additions & 8 deletions packages/documentation/src/blogs/v2-release.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,10 +70,11 @@ throughout your app because some patterns seem repetitive.
> `react-md` with JavaScript as you have done before, but all the examples and
> documentation will be written with Typescript.
[v1.1.0](/v1/discover-more/whats-new#v1-1-0-released) was the first `react-md`
release to add support for Typescript but unfortunately the type definitions
were [not that great]({{GITHUB_URL}}/blob/v1/src/js/index.d.ts) because I did
not fully understand Typescript and kept getting out of sync or forgotten. Since
[v1.1.0](https://mlaursen.github.io/react-md-v1-docs/#/discover-more/whats-new#v1-1-0-released)
was the first `react-md` release to add support for Typescript but unfortunately
the type definitions were
[not that great]({{GITHUB_URL}}/blob/v1/src/js/index.d.ts) because I did not
fully understand Typescript and kept getting out of sync or forgotten. Since
Typescript is becoming the new trend for web development with additional tooling
and editor integrations, it seemed like a good time to finally start learning
Typescript and re-write `react-md` to use it natively.
Expand Down Expand Up @@ -327,10 +328,10 @@ following actions happens:
![v1 implementation](https://i.imgur.com/MTxYr1e.mp4)

v1 of `react-md` had a very "noisy" implementation of this with the
[ripple/ink effect](/v1/components/inks) which caused a 300ms animation each
time the user interacted with a focusable element. This was _okay_ for the tap
and click behaviors but extremely obnoxious for keyboard users especially when
tabbing through elements quickly.
[ripple/ink effect](https://mlaursen.github.io/react-md-v1-docs/#/components/inks)
which caused a 300ms animation each time the user interacted with a focusable
element. This was _okay_ for the tap and click behaviors but extremely obnoxious
for keyboard users especially when tabbing through elements quickly.

In addition there would sometimes be `:hover` styles applied accidentally after
a user touches an element on mobile since touch events also trigger the `:hover`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -181,7 +181,8 @@ Theme Guide] instead using the [prefers-color-scheme media query].

[theme values]: /packages/theme/sassdoc#theme-variable-rmd-theme-values
[theme builder]: /colors-and-theming/theme-builder
[v1 theme builder]: /v1/customization/theme-builder
[v1 theme builder]:
https://mlaursen.github.io/react-md-v1-docs/#/customization/theme-builder
[react context api]: https://reactjs.org/docs/context.html
[theme builder github folder]:
{{GITHUB_FILE_URL}}/packages/documentation/src/components/ColorsAndTheming/ThemeBuilder
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ export default forwardRef<HTMLAnchorElement, Props>(function Version1MenuItem(
ref={ref}
id="version-1-link"
leftAddon={!small && <LinkSVGIcon />}
href="https://react-md.dev/v1"
href="https://mlaursen.github.io/react-md-v1-docs/"
onClick={(event) => {
if (onClick) {
onClick(event);
Expand Down
4 changes: 2 additions & 2 deletions packages/react-md/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -283,7 +283,7 @@ throughout your app because some patterns seem repetitive.
> `react-md` with JavaScript as you have done before, but all the examples and
> documentation will be written with Typescript.
[v1.1.0](/v1/discover-more/whats-new#v1-1-0-released) was the first `react-md`
[v1.1.0](https://mlaursen.github.io/react-md-v1-docs/#/discover-more/whats-new#v1-1-0-released) was the first `react-md`
release to add support for Typescript but unfortunately the type definitions
were [not that great]({{GITHUB_URL}}/blob/v1/src/js/index.d.ts) because I did
not fully understand Typescript and kept getting out of sync or forgotten. Since
Expand Down Expand Up @@ -540,7 +540,7 @@ following actions happens:
![v1 implementation](https://i.imgur.com/MTxYr1e.mp4)

v1 of `react-md` had a very "noisy" implementation of this with the
[ripple/ink effect](/v1/components/inks) which caused a 300ms animation each
[ripple/ink effect](https://mlaursen.github.io/react-md-v1-docs/#/components/inks) which caused a 300ms animation each
time the user interacted with a focusable element. This was _okay_ for the tap
and click behaviors but extremely obnoxious for keyboard users especially when
tabbing through elements quickly.
Expand Down
2 changes: 1 addition & 1 deletion packages/react-md/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Create an accessible React application with the
- [Library Size](#library-size) - The UMD bundle size for the entire `react-md`
library and sizes for some of the pre-built css files.

#### If you are still on v1, please see the [v1 documentation site](https://react-md.dev/v1) and [branch](../../tree/v1) instead
#### If you are still on v1, please see the [v1 documentation site](https://mlaursen.github.io/react-md-v1-docs/) and [branch](https://github.com/mlaursen/react-md-v1-docs) instead

## Installation

Expand Down

0 comments on commit 92801bb

Please sign in to comment.