GithubHelp home page GithubHelp logo

react-router-website's Introduction

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 People

Contributors

aakashsardana avatar brophdawg11 avatar chaance avatar dependabot[bot] avatar github-actions[bot] avatar iamyoungbossy avatar jimniels avatar machour avatar mcansh avatar michaeldeboey avatar mjackson avatar psullivan6 avatar ryanflorence avatar sinchang avatar xhomu avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

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:

image

- 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)

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.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.