Language/Multiple-languages/Culture/How-to-Study-with-a-Markup-Language

From Polyglot Club WIKI
Jump to navigation Jump to search
Rate this lesson:
5.00
(one vote)

Markup Tools Comparison

On the journey of studying, you will find it crucial to be efficient, to do less and achieve more. In this lesson, we will see how to improve your efficiency on the aspect of note-taking.

What is a markup language?

It is simple: if the word processor reads specific character or combination of characters, it will format them in a specific manner visually. Websites use HTML, together with other languages, to display contents. You can find its code by right clicking on a page and selecting “View Page Source”. MediaWiki is a program written in PHP with its own markup syntax. You can view the source code of this page to find it out.

Markup languages are easy to manage, as a text editor can do the work, which is not supported by formats like DOC and PPT. Among markup languages, Markdown is the most popular one.

Here is a list of some open-format markup languages:

field language
2D graphics
documents
mathematical expressions
music engraving
to-do-list

There can be multiple available processors for a language. Different processors are used differently.

Which one is the best for language learning?

Among lightweight markup languages, Markdown was created early and has several dialects:

format link
CommonMark https://commonmark.org/
GitHub Flavored Markdown https://github.github.com/gfm/
Markdown Extra https://markdown-extra.readthedocs.io/
MultiMarkdown https://fletcherpenney.net/multimarkdown/
R Markdown https://rmarkdown.rstudio.com/
ScholarlyMarkdown http://scholarlymarkdown.com/
Stack Overflow Markdown https://stackoverflow.com/editing-help

AsciiDoc has more features with less popularity. Those wiki languages are more powerful and require more efforts like setting up a server and then open a client to access the content, as those languages were created for web use.

How to make use of Markdown or AsciiDoc?

There is a redpen for proofreading.

To convert to and from other formats, there is a pytablewriter to use.

Markdown

Some open-source programs for learning are

program link feature
Foam https://foambubble.github.io/ graph
hascard https://github.com/Yvee1/hascard flashcard
Joplin https://joplinapp.org/ notebook
Lazycard https://github.com/hikikones/Lazycard flashcard
markdown-anki-decks https://github.com/lukesmurray/markdown-anki-decks exporter to Anki
markmap https://markmap.js.org/ mind map
Markor https://github.com/gsantner/markor text editor
MDAnki https://github.com/ashlinchak/mdanki exporter to Anki
mdSilo https://mdsilo.com/ notebook
Mindolph https://github.com/mindolph/Mindolph knowledge manager
NoteKit https://github.com/blackhole89/notekit notebook
Recall https://github.com/frenya/vscode-recall flashcard
StudyMD https://github.com/jotron/StudyMD flashcard

Some of them are VSCodium / VS Code extensions. You will need to install VSCodium to make use of it.

You can write down your text like this

# inflection

## conjugation

  1. third person singular
    1. -s
    2. -es
    3. -'s
  2. past
    1. -ed / -d
    2. irregular
  3. past particle
    1. -en / -n
    2. irregular

## declension

  1. plural
    1. -s
    2. -es
    3. -i

markmap will treat it as a mind map, hascard will treat it as a flashcard.

AsciiDoc

There is one open- program to do the work: Asciidoctor. It supports Ruby, Java and JavaScript, extensions are available. Others are

program link feature
HonKit https://github.com/honkit/honkit building books
AsciidocFX https://github.com/asciidocfx/AsciidocFX building books
nb https://github.com/xwmx/nb creating notebooks

Mermaid

Mermaid is a JavaScript library to generate charts from its own markup language.

Other Lessons

Contributors

GrimPixel, Vincent and Maintenance script


Create a new Lesson