Skip to content
MinesParis PSL P25 MinesParis PSL P25 UE12/UE22 - Accueil

vs-code & markdown

éditeur de code : micro-démo

micro démo de Visual Code sur le fichier foo.txt

  • depuis le terminal, aller dans le bon répertoire et lancer
    Terminal window
    code .

manipulations simples

pour plus de détails, voir aussi https://code.visualstudio.com/docs/getstarted/userinterface

on va montrer comment

  • afficher/cacher l’explorateur de fichiers
  • créer un nouveau fichier ⌃-N (sur MacOS: ⌘-N)
  • lui donner un nom foo.txt avec le raccourci ⌃-S (ça pourrait être quoi sur mac ?)
  • modifier foo.txt, sauver la version modifiée
  • créer un nouveau fichier bar.txt, le sauver
  • montrer l’effet de l’autosave (menu File), il est recommandé de l’activer ! montrer l’effet d’un fichier non sauvé (une boule noire au lieu de la croix, dans l’onglet à coté du nom de fichier)
  • observer le contenu des fichiers depuis le terminal avec cat
  • montrer comment se manifeste la fin de ligne
ouvrir avec simple-clic ou double-clic

essayez d’ouvrir un fichier (pas encore ouvert) depuis l’explorateur avec un simple ou un double clic
il y a une différence subtile, pour la voir ouvrez-en plusieurs…

gestion des fenêtres

montrer des manipulations élémentaires de fenêtres

  • afficher les deux fichiers côte à côte
  • puis l’un au dessus de l’autre

extensions

  • chercher une extension
  • installer/désinstaller
  • activer/désactiver une nouvelle extension
  • à faire: installer les extensions
    • Python (de Microsoft)
    • Jupyter (de Microsoft aussi)

la palette

  • de retour dans vs-code, montrer la palette :
    • ⇧ ⌘ P Shift-Command-P (mac)
    • ⇧ ⌃ P Shift-Control-P (windows)
  • chercher une commande, par exemple Format Document

basculer entre les applications

  • passer d’une application à une autre avec ⌥ ⇥ (Alt-Tab)
  • typiquement pour basculer entre vscode et terminal

conseils

markdown

c’est un format simple, léger et bien pensé pour mettre en forme facilement vos textes, il est devenu le couteau suisse pour écrire des documents

  • avec un minimum de présentation
    • sections
    • listes
    • gras, italique, code
    • liens
    • maths
  • toujours dans un fichier texte (c’est à dire par exemple, pas comme dans Word)
  • ce qui le rend diff-friendly, donc git-friendly

format très populaire en ce moment, supporté e.g. :

  • dans github
  • dans les notebooks, justement,
  • et dans la plupart des réseaux sociaux: discourse, discord, slack…
  • notamment sur whatsapp (partiellement), …

et plus généralement dans tous les sites web de forums/blogs, où on peut entrer du texte directement depuis le navigateur

micro-démo sous vs-code

sous vs-code

  • créer un fichier foo.md
  • remarquer la petite icône fig-vscode-markdown.png
    • afficher côte à côte le markdown brut et rendu
  • rapide survol
    • sections
    • listes avec et sans numérotation
    • gras, italique
  • insister sur les plusieurs façons de mettre du code,
    • soit inline sans saut de ligne, ou alors
    • avec des “triple ticks” ```
  • images et liens

voyez la cheatsheet github ici https://enterprise.github.com/downloads/en/markdown-cheatsheet.pdf

mathjax

on peut aussi écrire des maths en markdown, ça se fait en utilisant le langage
c’est un peu abscons au début mais on s’y habitue vite, en tous cas ça produit de très jolies équations, comme par exemple

inline

à la base markdown utilise pour ça le signe $

si vous voulez mettre des maths dans un paragraphe (on dit inline), vous utilisez un seul $ au début et à la fin de l’équation; c-à-d si vous écrivez

voici une petite équation $y = x^2 +2x +1$ au milieu de la ligne

vous obtenez

voici une petite équation au milieu de la ligne

paragraphe séparé

pour mettre une équation dans un paragraphe séparé on double le dollar de début et de fin

du coup

$$
\forall x \in \mathbb{R}, \forall \epsilon \in \mathbb{R}^+, \exists\alpha\in\mathbb{R}^+ \\
 |x'-x| < \alpha\implies |f(x')-f(x)| < \epsilon
$$

se présentera comme ceci :

au passage, vous remarquez que les commandes commencent par \

les mots du jargon

ça dépasse complètement notre périmètre que d’essayer de faire le tour de ; je préfère commencer par quelques exemples qui devraient vous permettre de démarrer

\forall x \in \mathbb{R},
\; \exists y \leq \epsilon
x_1=\frac{-b+\sqrt{b^2-4ac}}{2a}
$$
A_{m,n} =
 \begin{pmatrix}
  a_{1,1} & a_{1,2} & \cdots & a_{1,n} \\
  a_{2,1} & a_{2,2} & \cdots & a_{2,n} \\
  \vdots  & \vdots  & \ddots & \vdots  \\
  a_{m,1} & a_{m,2} & \cdots & a_{m,n}
 \end{pmatrix}
$$
\sum_{i=0}^n i^2 = \frac{(n^2+n)(2n+1)}{6}
pour aller plus loin

ceux qui veulent creuser peuvent