pmndrs / r3f-website

Website for React Three Fiber

React Three Fiber Website

Demo: https://r3f.netlify.app

How to run locally

git clone [email protected]:react-spring/r3f-website.git
cd r3f-website
yarn && yarn start

How to add docs

1. Create a markdown file in the docs folder in the section you feel it's a better suit for what you are writing.

2. To add to the sidebar please edit the sidebar.yaml to point yo your new doc

r3f-website's Issues

Background changes to white color (BUG)

How to reproduce:

1. Go to docs page
2. Click on Get started now! link
3. We get a 404 page error (the page doesn't exist) (Link)
4. Hover in the link click here

Issue

The background turns into white color in all the docs, so the font is very difficult to read.

It's Happening on:
Chrome 83
Firefox 77

How to contribute with docs?

I would like to add an example about how to load some models (gltf/dae). Is there some rules or a template to do a PR to the docs site?

Amazing work for the docs, I really like it :)

Using github and codesandbox to host examples

I made a test using example apps stored in the main repository that are then converted to live sandboxes using githubbox

Preview:

https://hungry-liskov-659c72.netlify.app/docs/example-test/

Code:

https://github.com/gsimone/r3f-website

Doing it like this would allow us to better maintain examples:

• keep examples PRable and contributable ( is that a word? )
• keep dependencies up to date for all examples

It's a simple as pushing the example and using the github url in the iframe code:

<iframe
    src="https://codesandbox.io/embed/github/gsimone/r3f-website/tree/master/src/examples/example-name"
></iframe>

We could easily provide a default repo to clone new examples from.

Just an idea, let me know what you think - opened an issue since discussions are not on.