remix-run / react-router-website

The React Router website

React Router Website!

Setup

Copy the contents of .env.example file to the .env file and add your information to it.

cp .env.example .env

Install dependencies

npm install

That's it!

Development

npm run dev

There are a couple LRUCache's for talking to GitHub and processing markdown that expire after 5 minutes, if you want them to expire immediately for local development, set the NO_CACHE environment variable.

NO_CACHE=1 npm run dev

To work on local docs clone the react router repo and put it in the same folder as this website repo:

~/ur-stuff/reactrouter-website
~/ur-stuff/react-router

Then point .env at it like this:

LOCAL_REPO_RELATIVE_PATH="../react-router"

You'll notice a "local" option in the version dropdown menu when the app is running. That will pull the docs from your machine instead of GitHub.

Roadmap

• Handle translations
• Allow links to link to ".md" so code completion works when editing docs (sorry, this is a stupid @ryanflorence/md thing, need open that up so we can do more w/ markdown across all our sites)
• parse out descriptions in @remix-run/md and add to seo
• create resource route so the og:image is the first code block of the doc (with syntax highlighting!)

react-router-website's Issues

[Bug]: `useLocation` docs url on vs code redirect to a 404 page

What version of React Router are you using?

6.4.3

Steps to Reproduce

• Create a simple react project with react-router 6.4.3
• Call the useLocation hook -> const location = useLocation()
• Hover the useLocation() and a pop-up will appear:

- If you press on the url, it returns a 404 page because it redirects to https://reactrouter.com/en/6.5.0/docs/en/v6/hooks/use-location instead of https://reactrouter.com/en/main/hooks/use-location or something like that

Expected Behavior

Redirecting to the useLocation() docs page

Actual Behavior

Redirecting to 404 page

Edit: All the hooks docs url are wrong. The problem here is that i'm using an old react router version (6.4.3) instead of the main one (6.5.0)

[Bug]: Docs are not working (Something went wrong)

What version of React Router are you using?

docs

Steps to Reproduce

1. navigate to https://reactrouter.com/
2. click on any link
3. click on go back (browser)

Expected Behavior

should not crash

Actual Behavior

Happens not only to me.

[Docs]: Active links are not indicated on the right navigation section.

Describe what's incorrect/missing in the documentation

It would be nice to know where you are using the side navigation when reading a docs page.

In this case, the nested route on the list on the right should be either highlighted or underlined.

I have yet to try Remix, but this would be an excellent PR to get my feet wet.

Is anyone working on this?

issue with example We have an example for this: https://github.com/remix-run/react-router/tree/dev/examples/auth

          We have an example for this: https://github.com/remix-run/react-router/tree/dev/examples/auth

Originally posted by @timdorr in remix-run/react-router#10206 (comment)

Sorry, not shure is there a bug or stackblitz fault, but

$ vite
failed to load config from /home/projects/mkligxplv.github/vite.config.ts
error when starting dev server:
Error: The package "@esbuild/linux-x64" could not be found, and is needed by esbuild.

on https://stackblitz.com/github/remix-run/react-router/tree/main/examples/auth?file=src%2FApp.tsx

Fix www redirections

http://www.reactrouter.com and https://www.reactrouter.com currently show a 500 error.
Should redirect to https://reactrouter.com instead.