August 17th, 2021
How many have used something like Markdown, ReStructured Test (RST), …
From the Commonmark home page:
It’s a plain text format for writing structured documents, based on formatting conventions from email and usenet.
Using raw HTML can be quite tedious for everyday types of writing or code documentation. In addition, taking the time to insert HTML tags can make the already painful task of writing even more horrible.
This is why I use markdown to generate the bulk of my HTML content, but not HTML GUIs.
Sites such as GitHub, Bitbucket, Reddit, Diaspora, Stack Exchange, OpenStreetMap, and SourceForge use variants of Markdown to facilitate discussion between users.
Markdown is very popular with static site generators. From the Wintersmith home page:
No more fiddling around with WYSIWYG editors. Once you start using Markdown to author your content you’ll never look back! Wintersmith’s markdown plugin allows you to use markdown as backing for all your sites content, not just blog posts.
README.MDMarkdown file for your repository.
A number of choices
For italic surround with
*CS351*, yields: CS351
For bold surround with
**CS351**, yields CS351
Bold and italic? How about
***CS351***, yields CS351
You start a line with a
# for an
You start a line with
## for an
Bullet lists start with
* followed by a space.
Numbered lists start with a
1. followed by a space.
A new paragraph is started by skipping a line
A block quote is started with a
> at the beginning of a line.
```html <p>Some HTML code <span>highlighted</span></p> <p>Another Paragraph</p> ```
Syntax Highlighted Code
<p>Some HTML code <span>highlighted</span></p> <p>Another Paragraph</p>
If time permits we’ll do a practice question together!
I want to use
<article> and other nice HTML5 elements.
The CommonMark specification allows you to put HTML blocks into your markdown document and have them interpreted as HTML!
This is how I add structure to the homework and other files.