Skip to content

Commit

Permalink
remove old note about hugo docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Tim Kye authored and Tim Kye committed Nov 20, 2020
1 parent 43d58df commit 6e6b565
Showing 1 changed file with 0 additions and 10 deletions.
10 changes: 0 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,13 +74,3 @@ function UserList ({ users }) {
The preferred method for navigation is the `<Link>` component, which uses all the same properties as the standard `<a>` element, and requires `href`. Internally `<Link>` uses `history.pushState` to ensure navigation without a page refresh. If you need to perform programmatic navigation raviger exports a `navigate` function.

Some routing libraries only trigger React component updates if navigation was triggered using specific methods, such as a specific instance of **history**. **raviger** listens for all `popstate` events and checks for changes. You can even have two isolated React instances on a page and URL changes will properly trigger **raviger** hooks.

## Contributing

Docs are built with [Hugo](https://gohugo.io/documentation/) and stored on the **master** branch. To contribute clone the repo, [install hugo](https://gohugo.io/getting-started/installing/), and `make run-docs` to run the docs site locally

```bash
make run-docs # run hugo in watch mode.
```

When you are done open a **Pull Request** against the **master** branch (not *gh-pages*!)

0 comments on commit 6e6b565

Please sign in to comment.