Workshop template

A React-based workshop template. It basically reads a markdown file, splits it into steps, and formats it nicely.

An example of what you get: https://wildcodeschool.github.io/initiation-javascript/

For the non-JS out there, you need Node.js, which you should install with NVM (Linux/MacOS) or NVM-Windows.

1. Create the new workshop repository

Don't fork this repository.

1. Download it as a ZIP Archive with the big green button!
2. Create a new repo from its content

OR duplicate it with CLI

1. Create a new repository https://github.com/WildCodeSchool/new-workshop
2. Duplicate this repository

git clone --bare git@github.com:WildCodeSchool/workshop-template.git
cd workshop-template
git push --mirror git@github.com:WildCodeSchool/new-workshop

2. Change its parameters

In package.json, replace workshop-template with your own workshop URL (e.g. farting-unicorns) in the homepage value (and also in name but that doesn't matter).

3. Edit it!

The content is located in public/content.md.

You just have to follow its conventions:

• # for title, ## for subtitle
• The first #### and content below will be displayed as an introduction.
• All the following #### and content will be displayed as a card, and their titles automagically added to the left nav menu.

4. Preview it

• npm install or yarn to install dependencies
• npm start or yarn start to launch

5. Push and deploy it!

Once pushed, you should just have to run npm run deploy or yarn deploy.