Back to all Bounties
Earn 1,800 ($18.00)
due 3 years ago
Completed
Create a Markdown Tutorial
mikeatreplit
Details
Applications
7
Discussion
This Bounty has been completed!
@mikeatreplit's review of @TechPandaPro“TechPandaPro created a thoughtful and well-written markdown tutorial for my Bounty. Great communication skills and super responsive over email.”
5.0
Communication 5/5, Quality 5/5, Timeliness 5/5Bounty Description
Problem Description:
We use Markdown in a few places on Replit, but we don't have any docs on docs.replit.com that explain how to use Markdown. There are plenty of guides around the web that explain Markdown, but we'd like to host our own guide that explains the basics for a beginner (i.e. someone with little to no programming experience).
Acceptance Criteria:
- Work should be done in a private Repl.
- It should feature a tutorial.md file along with any supporting images.
- It should cover the below content in a beginner-friendly way.
- For each section, I'd like to see a short explanation of the concept, an example of the syntax and a screenshot of the rendered markdown (in our markdown preview in Replit Light theme). For reference, see how GitHub does it: https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#links.
- Writing must be original content - it cannot be copied and pasted from another source.
Content outline:
- What is markdown? A short paragraph.
- Creating hyperlinks
- Creating images (note: for this section, I only care about links to external images, not about hosting images)
- Creating headers
- Creating lists (ordered and unordered)
- Creating code snippets
- Cheat sheet of other markdown syntax (bold, italics, strikethrough, tables, task lists, blockquotes)
If you've written any educational materials before, please link them in your application!