About (Part to remove)

Template repository for SFEIR School, this template could be use to start a school with revealJS and SFEIR School theme

Don't forget to replace all xxx by your techno

Files to changes

• docs/scss/slides.scss you could put here all your custom styles
• docs/scripts/slides.js you will reference all the markdown here. Don't forget to have 1 function per chapter (module).
• docs/index.html you should reference the correct technology in header

To helps you

Video to help you to create your slides with revealJS

You could also look at documentation of school theme : https://github.com/sfeir-open-source/sfeir-school-theme

Tasks to do

• [] Change the files (cf before)
• [] Replace all xxx by your techno
• [] Remove this part of README
• [] Complete the README with your content
• [] Check that the github pages is pointing to /docs directory

Content of README

The text below is the template you could use for your readme

SFEIR School XXX

Discover the SFEIR Schools

Slides

You can view the slides here.

Develop

To run docs locally, go in directory docs and run npx serve of if you don't have node, you can use docker docker-compose up, and open slides on http://localhost:4242/.

Workshop

Workshops are in directory steps :

• two directories per workshop :
  • one with a README.md with workshop steps and source file to complete
  • a second directory suffixed with -solution which contains source file with solutions.

Contributing

Contributing Guidelines

Read through our contributing guidelines to learn about our submission process, coding rules and more.

Want to Help?

Want to file a bug, contribute some code, or improve documentation? Excellent! Read up on our guidelines for contributing and then check out one of our issues labeled as help wanted or good first issue.

Code of Conduct

Help us keep Angular open and inclusive. Please read and follow our Code of Conduct.