/redwoodjs.com

Public website for RedwoodJS

Primary LanguageHTML

redwoodjs.com

This is the repo for https://redwoodjs.com

The content for the tutorial is pulled from TUTORIAL.md in this repo.

Other documentation is pulled from various READMEs in the main redwoodjs/redwood repo (see lib/build.js, the SECTIONS constant).

Local Development

This codebase is built with https://cameronjs.com and relies on plain HTML pages and Javascript with a couple helpers built in to abstract things like partials and layouts. We use https://stimulusjs.org for the few sprinkles of interactivity throughout the site.

Copy .env.example to a file named .env and get API keys/IDs for all of the service listed. Alternatively, if you don't care about populating search comment out the require statement for search.js in lib/build.js and the publishSearch() function call towards the end of the main() function.

To build the tutorial and doc pages:

yarn build

To develop locally:

yarn dev

If you are already already running a yarn dev process when you yarn build you may need to stop and start yarn dev to pick up the new pages properly.

Contributing

Open a PR against the repo on GitHub. That will build and launch a copy of the site that you can get from the netlify/redwoodjs/deploy-preview check (click "Details" to open it):

image

Double check that your changes look good!