This is a repo dedicated to the iOS codebar Workshop. These materials can be used during a normal codebar workshop as long as a coach is there with the skill set.
We are now using docusaurus to build our tutorials. You will need npm installed on your computer to get started.
- Fork this repo
- Using a terminal, navigate into
src/website - Run
npm ito install all dependencies - Run
npm run startto run the website locally.
- Create the page in the
docsfolder (make sure it follows the same structure as the others) - Any images you need can be places in a folder in
docs/assets - Make sure you link to it in the
website/sidebars.jsonproperly. - To test the sidebars you need to stop running it locally, then run it again.
- If required, add a section in
website/pages/index.jsso everyone knows it exists!
We're using GitHub pages to host whatevers in the docs folder in root. Unfortunately this is a little bit of a manual process at the moment but you need to:
- Navigate to
src/website - Run
npm run build - Copy the
ios-tutorialsfolder into the root of this directory - Delete the
docsfolder (it's okay, we're going to fix this in a second) - Rename
ios-tutorialstodocs.