Index of /publis/slides/2017_02__Markdown_and_MediaWiki_primer_at_Supelec

	Name	Last modified	Size	Description
	Parent Directory		-
	.ipynb_checkpoints/	2021-02-23 11:50	-
	images/	2021-03-04 16:26	-
	Makefile	2021-03-04 16:26	1.1K
	README.md	2021-03-04 16:26	3.4K
	README.txt	2021-03-04 16:26	3.4K
	document_typora.md	2021-03-04 16:26	3.6K
	document_typora.pdf	2021-03-04 16:26	203K
	reveal.json	2021-03-04 16:26	3.1K
	slides.html	2021-03-04 16:26	5.0K	GouTP @ SCEE | Date: 23 Feb 2017 | By: Lilian Besson | About: Markdown & MediaWiki
	slides.ipynb	2021-03-04 16:26	80K
	slides_marp.md	2021-03-04 16:26	3.6K
	slides_marp.pdf	2021-03-04 16:26	198K
	slides_pandoc.md	2021-03-04 16:26	3.7K
	slides_pandoc.pdf	2021-03-04 16:26	165K
	slides_pandoc_169.pdf	2021-03-04 16:26	165K
	slides_reveal.md	2021-03-04 16:26	3.3K

GouTP @ SCEE

• About:

  • Markdown: concept, syntax, tools
  • Wiki & MediaWiki

• Date: 23 Feb 2017

• Who: Lilian Besson, lilian.besson@supelec

Outline

1. Intro: markup languages

2. Markdown

   • Syntax, examples
   • Experiment with Markdown :boom: !
   • 2 tools: demo of Typora and Marp
   • Pro tool : pandoc (another GouTP)

3. MediaWiki

   • For Wikipedia, and our internal SCEE Wiki

Intro: why using markup languages?

Facts

• LaTeX and HTML can be painful to write manually :cry:
• Hard to read and parse for a human, and need a learning time

Solution ?

• Use a markup language as simple as possible :smiley:
• For many use, a lightweight markup language is enough:
  1. write simple text with light markup
  2. convert the text to PDF, LaTeX, HTML etc.
• Example: Wikipedia pages are not written in HTML ...

1. Markdown

Close to the "natural" syntax we use in emails :e-mail:

• Emphasis: *italic*, **bold**, ~~striked~~
• Lists: unumbered with - item, numbered with 1. item
• Titles: # Title 1, ## Heading 2, ### Heading 3 etc
• Links: [text](address) and image: ![alt](cat.png)
• Quote: like emails, > quote ...

Example of Markdown output

Heading 2

• Emphasis: italic, bold, striked
• Lists, one item by line,:
  1. unnumbered with - item
  2. numbered with 1. item

Heading 3

• Links: commonmark.org
• and image:

  Quote: like emails, > quote ...

Markdown tutorial

No official reference for the syntax, but the best reference is CommonMark (CommonMark.org)

• Markup reference: CommonMark.org/help :information_desk_person:

• 5 minutes tutorial: CommonMark.org/help/tutorial :computer: :keyboard: → Let's do it now!

There is plenty of syntax extensions: for tables, footnotes, etc

Demo time: Typora for notes

• Markdown document writer: typora.io

Demo time: Marp for slides

• Markdown presentation writer, free and open-source: yhatt.github.io/marp

Marp: Features

• Free and open-source
• Slides are written in pure Markdown.
• Cross-platform. Supports Windows, Mac, and Linux
• Live Preview with 3 modes
• Slide themes and custom background images
• Supports emoji :heart:
• Render maths in your slides: $$\mathrm{e}^{i \pi} = -1$$
• Export your slides to PDF

2. MediaWiki

• A Wiki tool, free and open-source, powering Wikipedia :earth_americas: → mediawiki.org
• Syntax very close to Markdown, only small differences

Used internally @ SCEE for our MediaWiki: demo time MediaWiki on WS4 (→ HP-SCEE-1, IP: 172.16.3.80)

• Log in, edit a page, save it :computer: :keyboard: → Let's try it now!

Conclusion :candy:

• I hope you learned how to use Markdown & MediaWiki
• Now... use it ! :smile:

• Try to edit our SCEE MediaWiki, if you want to add content :mag:

• If you are curious about a more complete use of Markdown, try to practice with it, and wait for next GouTP on Advanced Markdown with pandoc !

Thanks for coming! :wave: