Skip to content

Commit

Permalink
Added Title page (#11)
Browse files Browse the repository at this point in the history
* feat: add title page

* add shell dollar to `README.md`

* remove dollar from command lines, add title to contributors

* update contributors link
  • Loading branch information
jeremyle56 authored Mar 12, 2024
1 parent 17916b7 commit bdd0c13
Show file tree
Hide file tree
Showing 4 changed files with 39 additions and 4 deletions.
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```
6 changes: 4 additions & 2 deletions book/src/SUMMARY.md
Original file line number Diff line number Diff line change
@@ -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)
15 changes: 15 additions & 0 deletions book/src/title-page.md
Original file line number Diff line number Diff line change
@@ -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).
12 changes: 12 additions & 0 deletions contributors.md
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit bdd0c13

Please sign in to comment.