{ "cells": [ { "cell_type": "markdown", "metadata": { "deletable": true, "editable": true, "slideshow": { "slide_type": "slide" } }, "source": [ "# GouTP @ SCEE\n", "\n", "- *About:*\n", " - Markdown: concept, syntax, tools\n", " - Wiki & MediaWiki\n", "\n", "- *Date:*\n", " 23 Feb 2017\n", "\n", "- *Who:*\n", " Lilian Besson, `lilian.besson@supelec`" ] }, { "cell_type": "markdown", "metadata": { "deletable": true, "editable": true, "slideshow": { "slide_type": "slide" } }, "source": [ "# Outline\n", "0. Intro: markup languages\n", "\n", "1. Markdown\n", " - Syntax, examples\n", " - Experiment with *Markdown* !\n", " - 2 tools: demo of *Typora* and *Marp*\n", " - Pro tool : `pandoc` (another GouTP)\n", "\n", "2. MediaWiki\n", " - For Wikipedia, and our internal SCEE Wiki" ] }, { "cell_type": "markdown", "metadata": { "deletable": true, "editable": true, "slideshow": { "slide_type": "slide" } }, "source": [ "# Intro: why using markup languages?\n", "## Facts\n", "- $\\LaTeX{}$ and HTML can be painful to write manually\n", "- Hard to read and parse for a human, and need a learning time\n", "\n", "## Solution ?\n", "- Use a **markup language as simple as possible**\n", "- For many use, a lightweight markup language is enough:\n", " 1. write *simple text* with light markup\n", " 2. *convert* the text to PDF, $\\LaTeX{}$, HTML etc.\n", "- Example: *Wikipedia* pages are not written in HTML ..." ] }, { "cell_type": "markdown", "metadata": { "deletable": true, "editable": true, "slideshow": { "slide_type": "slide" } }, "source": [ "# 1. Markdown\n", "> Close to the \"natural\" syntax we use in emails\n", "\n", "- Emphasis: `*italic*`, `**bold**`, `~~striked~~`\n", "- Lists: unumbered with `- item`, numbered with `1. item`\n", "- Titles: `# Title 1`, `## Heading 2`, `### Heading 3` etc\n", "- Links: `[text](address)` and image: `![alt](cat.png)`\n", "- Quote: like emails, `> quote ...`" ] }, { "cell_type": "markdown", "metadata": { "deletable": true, "editable": true, "slideshow": { "slide_type": "slide" } }, "source": [ "# Example of Markdown output\n", "## Heading 2\n", "- Emphasis: *italic*, **bold**, ~~striked~~\n", "- Lists, one item by line,:\n", " 1. unnumbered with `- item`\n", " 2. numbered with `1. item`\n", "\n", "### Heading 3\n", "- Links: [commonmark.org](http://commonmark.org)\n", "- and image: ![logo](https://raw.githubusercontent.com/dcurtis/markdown-mark/master/png/66x40-solid.png)\n", "> Quote: like emails, `> quote ...`" ] }, { "cell_type": "markdown", "metadata": { "collapsed": true, "deletable": true, "editable": true, "slideshow": { "slide_type": "slide" } }, "source": [ "# Markdown tutorial\n", "> No official reference for the syntax, but the best reference is [CommonMark (`CommonMark.org`)](http://commonmark.org/)\n", "\n", "- Markup reference: [`CommonMark.org/help`](http://commonmark.org/help/)\n", "\n", "- 5 minutes tutorial: [`CommonMark.org/help/tutorial`](http://commonmark.org/help/)\n", " → **Let's do it now!**\n", "\n", "> There is plenty of syntax extensions: for tables, footnotes, etc" ] }, { "cell_type": "markdown", "metadata": { "collapsed": true, "deletable": true, "editable": true, "slideshow": { "slide_type": "slide" } }, "source": [ "# *Demo time:* Typora for *notes*\n", "- Markdown *document* writer:\n", " [`typora.io`](https://typora.io)\n", "\n", "