diff --git a/README.md b/README.md index 2e3d601..ffe4d55 100644 --- a/README.md +++ b/README.md @@ -35,7 +35,13 @@ When adding a new exercise Please check that the book will render properly by running the following command in the root directory: ```sh -$ mdbook build book --open +mdbook build book --open ``` -If the book has been updated correctly a new webpage will open in your browser. +If the book has been updated correctly a new webpage will open in your browser. You will need to have `mdbook` installed which can be done by following the [installation documentation](https://rust-lang.github.io/mdBook/guide/installation.html#installing-the-latest-master-version). + +Alternatively you can use the `serve` command, which will build your book and start a local web server: + +```sh +mdbook serve book --open +``` diff --git a/book/src/SUMMARY.md b/book/src/SUMMARY.md index 8f73a1f..7c5ada8 100644 --- a/book/src/SUMMARY.md +++ b/book/src/SUMMARY.md @@ -1,9 +1,11 @@ # Summary +[Training Program Exercises](title-page.md) + - [Getting Started](01_getting-started/index.md) - [Javascript](02_javascript/index.md) - - [Example Exercise](02_javascript/example.md) + - [Example Exercise](02_javascript/example.md) - [Figma](03_figma/index.md) - [React Basics](04_react-intro/index.md) - [Styling](06_styling/index.md) - - [DevWatch (TailwindCSS)](06_styling/devwatch.md) + - [DevWatch (TailwindCSS)](06_styling/devwatch.md) diff --git a/book/src/title-page.md b/book/src/title-page.md new file mode 100644 index 0000000..fb79d19 --- /dev/null +++ b/book/src/title-page.md @@ -0,0 +1,15 @@ +# DevSoc Training Program Exercises + +_by Dylan Huynh and Nicole Chun with contributions from the [DevSoc community](https://github.com/TAS-scorchedshadow/training-program-exercises/blob/main/contributors.md)_ + +Welcome to DevSoc's Training Program Exercises! This is a resource created by DevSoc volunteers for the Training Program to inspire and assist novice programmers gain basic web development skill in HTML/CSS, JavaScript and React. + +This site features a selection of guides and exercises intended for 2024 DevSoc Trainees and were made to go along with concurrent workshops. However you are welcome to use this for our own self learning. + +## Disclaimer + +While we try our best, we still may make mistakes here and there. If you spot any issues, mistakes or typos on this page fee free to create a [pull request](https://github.com/TAS-scorchedshadow/training-program-exercises/pulls) with the corrections or mention it in an [issue](https://github.com/TAS-scorchedshadow/training-program-exercises/issues). + +## Source Code + +The source files from which this site is generated can be found on [GitHub](https://github.com/TAS-scorchedshadow/training-program-exercises). diff --git a/contributors.md b/contributors.md new file mode 100644 index 0000000..3dfe271 --- /dev/null +++ b/contributors.md @@ -0,0 +1,12 @@ +# Contributors + +Special thanks to everyone who has helped create and improve this resource. In no particular order: + +- Dylan Huynh +- Nicole Chun +- Michael Vo +- Hanyuan Li +- Christian Lam +- Jayden Nguyen +- Alex Lee +- Jeremy Le