Skip to content

A collection of RST exercises, meant to be completed in the GitHub UI

License

Notifications You must be signed in to change notification settings

sarina/rst-tutorial

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

28 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

rst-tutorial

A collection of RST exercises, meant to be completed in the GitHub UI. Built specifically for contributors to the Open edX documentation project.

See this One-Page Guide to RST (PDF) and/or this quickreference to RST - they may help out as you go through these exercises.

Instructions

For each exercise, click into the named folder (start with "Exercise 1").

First, look at the file titled Match_This_Output.png. This is a picture of the output you're looking to generate with some RST!

Next, click on the Exercise file and click on the pencil icon on the top right of the file to edit it. You'll be taken to a text editor where you can add and remove text. Try answering the problem by typing RST text into this box.

Use the Preview tab to ensure your output matches the Match_This_Output.png screenshot.

Once it matches, no need to commit or issue a pull request. If you'd like to see how we solved the exercise, you can look at the "answer.rst" file. Click the Raw button to see how we wrote the RST.

About

A collection of RST exercises, meant to be completed in the GitHub UI

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published