| title | cover title | description | programming_language | learning objectives | estimated time | prerequisites | instructors | authors | editors | readings | ethical considerations | projects | resources | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
This is the title |
short title! |
A description of the workshop. |
python |
|
|
|
|
|
|
|
|
|
|
Welcome to my workshop! This is the first page (the first lesson).
To add a lesson, simply type your lesson content below the header. You can use typical markdown styles to format your text.
This is a subsection of the first lesson.
This is a sub-subsection of the first lesson. Note that level 3 headings will be displayed on the same page as the level 1 or 2 heading they are nested under, and will not appear in the table of contents. This can be useful for breaking down content into smaller, more manageable sections without cluttering the table of contents or creating new pages.
In addition to text content, you can also add images to your workshop. Images can help illustrate concepts, provide visual interest, and make your workshop more engaging.
To add an image to your workshop, you can use standard markdown syntax for images. Here is an example:
Replace /path/to/image.jpg with the path to your image file (located in designated folder in the /images folder)
You can include code snippets in your workshop using standard markdown syntax for code blocks. You can use three backticks (```) to start and end the code block, followed by the language identifier (e.g., python) to specify the language of the code snippet.
print("Hello, world!")In this example, python specifies the language of the code snippet, which helps DHRIFT format the code block correctly. You can replace python with other supported languages like javascript, html, console, etc., as needed.
There are several components you can incorporate into your lessons, including:
- The Python REPL: You can embed the Python REPL into your lessons by using the following tag:
- A download button: If you have files you'd like the participant to download, you can add a download button to your lessons with the appropriate files by using the following syntax:
Here, your_file1 and your_file2 are the two files to download (you can add as many as you'd like, just separate them with commas). The break tag at the end is just to add some space after the button. NOTE: You must include copies of the files indicated in the uploads folder.
- An info box: Use to highlight interesting additional information.
- A way to link internally to other workshops.
This is necessary when linking to another workshop page. 'workshop' is the workshop file name, and the 'page' can be found in the URL query string, for instance: ?user=dhri-curriculum&repo=workshops&file=command-line&**page=15**&instUser=dhri-curriculum&instRepo=dhrift-site-template
This is an evaluation, which you can utilize in the form of a quiz. For the syntax, see the example question and quiz below:
What are the characteristics of the REPL? Select all that apply.
- The REPL has a prompt that begins with `$`. - The REPL has a prompt that begins with `>>>`.* - The REPL and the terminal are the same thing. - The REPL can be used to evaluate mathematical expressions like `2 + 2`.* - keyword 1 definition 1- keyword 2 definition 2
Where are DHRIFT workshops stored?
In a GitHub repository.In this example, the (optional heading) Challenge section poses a question or problem, and the tag creates a hidden solution that learners can reveal by clicking a button. This allows learners to attempt the challenge on their own before checking the solution.
This is the second section (the second lesson) of the workshop. Provide as many pages as you'd like.