Skip to content

xieby1/markdown_cheatsheet

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

19 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🤓A Simple, Compact, Static Markdown to Cheatsheet Converter!

Intro

Prerequisite

  • shell
  • pandoc

Install

git clone https://github.com/xieby1/markdown_cheatsheet.git
ln -s <path/to>/cheatsheet.sh /usr/bin/
# or /usr/local/bin/, or ~/.local/bin/

Usage

  • Write markdown as usual

  • Generate html file like below:

    cheatsheet.sh <xxx.md>
    # output: xxx.html

Special Syntax

syntax meaning
1st-level header end of a container
2nd-level header start of container
3nd-level header start of an item

Feature

  • Simple, Compact, Static
  • Adaptive Screen Size

Demo

This README.md is converted:

see it on 📃Github Page.

TODO

  • Support 3rd party theme
  • TOC column fit content

Next is the Test

🐱1st-level header will start a new container!

各国语言

你好

Chinese

Hello

English

こんにちは

Japanese

안녕

Korean

Привет

Russian

வணக்கம்

Tamil

Ciao

Italian

नमस्ते

Hindi

Salve

Latin

Ahoj

Czech

Hola

Spanish

Halo

Indonesian

Hei

Finnish

Ahoj

Slovak

Selamat tengahari

Malaysian

Hallo

Dutch

مرحبا

Arabic

Aloha

Hawaiian

Hallo

Afrikaans

Bonjour

French

Hej

Swedish

Merhaba

Turkish

สวัสดีค่ะ / สวัสดีครับ

Thai

Inspired by

idiv-biodiversity's pandoc-cheat-sheet