Markdown
Język znaczników
Markdown - język znaczników. Powstał w 2004 jako prosty system formatowania tekstu, tak by był jednocześnie:
- łatwy w tworzeniu
- czytelny w swojej natywnej formie
- łatwy do konwersji na inne formaty, gł HTML i LaTeX
Z tych założeń wynika jego prostota. Znają go wszyscy wikipedyści, wikikod to po prostu markdown, z którego silnik mediawiki generuje treść strony.
Dzięki powyższym cechom Markdown jest najlepszą formą tworzenia dokumentacji. Natywnie zawiera w sobie większość cech potrzebnych przy tworzeniu zhierarchizowanego tekstu. Brakujące łatwo można uzupełnić przez różnego rodzaju dodatki. Największe możliwości daje popularne środowisko Pandoc. Mając już czytelny i posiadający wszystkie elementy formatowania plik źródłowy .md można go skonwertować na większość formatów dokumentów, najważniejsze to PDF, HTML i Latex.
Przejście do następnej lini: \ na końcu wiersza
Visual Studio Code
Lokalna kopia repozytorium na Githubie, pliki w formacie Markdown i VSC to - jak mi się zdaje - idealne połączenie na trzymanie i wygodną edycję, stale archiwizowanych plików i wygodnych w edycji plików z notatkami, dokumentacją, kodem.
Także dotyczy to stale rozwijanych artykułów na CMS. W tym ostatnim przypadku jest to już HTML, ale zapisany w formacie Markdown. Jak zmusić VSC do stosowania skrótów Emmeta w Markdown? - markdown not using emmet. W konfiguracji:
"emmet.triggerExpansionOnTab": true,
"emmet.excludeLanguages": [],
"emmet.includeLanguages": {
"markdown": "html"
},Dodatki:
- markdownlint by David Anson
- Markdown Preview Enhanced by Yiyi Wang - podgląd
- Markdown All in One by Yu Zhang - generowanie TOC
- inne: LaTeX Workshop, Citation Picker for Zotero
- Dendron The hierarchical note taking tool
MDX:
"files.associations": {
"*.mdx": "markdown"
},Odnośniki
- Markdown Tutorial
- Dillinger Online Markdown Editor
- adam-p/markdown-here: Markdown Cheatsheet
- Markdown Guide - Markdown Cheat Sheet
- cuonggt / markdown_guide.md - Markdown Guide
- GitHub Guides Mastering Markdown
- Chaitanya Baweja "Master Markdown in Ten Minutes A complete guide to designing content using Markdown"
- Daring Fireball Markdown
- GitbookIO/kramed - GitBook Document Everything! - GitbookIO/gitbook
- Pandoc - Pandoc Tricks
- Citation Style Language
- Build an Amazing Markdown Editor Using Visual Studio Code and Pandoc
- Automatic TOC in github-flavoured-markdown
- The Definitive, Non-Technical Introduction to LaTeX, Professional Typesetting and Scientific Publishing
- LATEX.css almost class-less CSS library turns your HTML document into a website that looks like a LATEX document
- joaoofreitas / markdown-webserver A NodeJS Application that transcripts Markdown to HTML, supporting MathJax and with GitHub flavoured style. Serving itself as a server.
YT
- [Will Ward "Building a Markdown Blog With React" YT playlist 6 filmów]
- Traversy Media ["Markdown Crash Course" YT 19:31]
- Nicholas Cifuentes-Goodbody ["Academic Writing in Markdown" YT 10:44]
- Marco Lancellotti "Markdown Tutorial (ITA)" [YT 27:30]
Narzędzia
- pbek / QOwnNotes plain-text file notepad and todo-list manager with markdown support and Nextcloud / ownCloud integration. - QOwnNotes
- readme.so The easiest way to create a README | [James Q Quick "Don't Create Markdown ReadMe Files Without ReadMe.so!!" YT 6:00]
- Obsidian
- GitBook
- Markdown to Slideshow : MarkShow
- readme.so
MDX
- MDX
- MDX Playground
- CSS Tricks Ollie Williams "Front-End Documentation, Style Guides and the Rise of MDX" | Agney Menon "An Introduction to MDXJS"
- Vsevolod "ASTs, Markdown and MDX"
- Marius Gundersen "MDX"
- N0K0 / gatsby-garden | Digital Zen Garden