Skip to content

docs: fix broken demo link, typo and warning callout syntax in README #175

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
xiakong130 wants to merge 1 commit into
base: main
Choose a base branch
from
+4 −3
Open

docs: fix broken demo link, typo and warning callout syntax in README #175

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,17 +33,18 @@ https://user-images.githubusercontent.com/6702424/148716227-4a699c07-ba17-4860-b
Try the demo project:

```bash
git clone https://github.com/garrone/gitlanding-demo
git clone https://github.com/garronej/gitlanding-demo
cd gitlanding-demo
yarn
yarn dev
```

> [!WARNING]: There are bugs when you use `<React.StrictMode />`...
> [!WARNING]
> There are bugs when you use `<React.StrictMode />`...

> [!NOTE]
> This project is an extension of [onyxia-ui](https://github.com/InseeFrLab/onyxia-ui) the
> gitlanding components needs be inside the `<OnyxiaUI>` provider.
> gitlanding components need to be inside the `<OnyxiaUI>` provider.
> Besides the required dependencies of onyxia-ui you only need to install `gitlanding`.

# Contributing
Expand Down