{"id":13592308,"url":"https://github.com/TobseF/boostnote-markdown-cheatsheet","last_synced_at":"2025-04-08T23:31:52.040Z","repository":{"id":55637734,"uuid":"158293866","full_name":"TobseF/boostnote-markdown-cheatsheet","owner":"TobseF","description":"📋 📘 The missing one page markdown feature cheat sheet for Boostnote","archived":false,"fork":false,"pushed_at":"2020-12-16T08:51:55.000Z","size":1948,"stargazers_count":284,"open_issues_count":0,"forks_count":179,"subscribers_count":9,"default_branch":"master","last_synced_at":"2025-04-02T05:47:09.242Z","etag":null,"topics":["boostnote","cheatsheet","markdown"],"latest_commit_sha":null,"homepage":"","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/TobseF.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-11-19T21:43:11.000Z","updated_at":"2025-01-12T21:57:02.000Z","dependencies_parsed_at":"2022-08-15T05:10:25.873Z","dependency_job_id":null,"html_url":"https://github.com/TobseF/boostnote-markdown-cheatsheet","commit_stats":null,"previous_names":[],"tags_count":0,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TobseF%2Fboostnote-markdown-cheatsheet","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TobseF%2Fboostnote-markdown-cheatsheet/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TobseF%2Fboostnote-markdown-cheatsheet/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TobseF%2Fboostnote-markdown-cheatsheet/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/TobseF","download_url":"https://codeload.github.com/TobseF/boostnote-markdown-cheatsheet/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247947814,"owners_count":21023057,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["boostnote","cheatsheet","markdown"],"created_at":"2024-08-01T16:01:07.868Z","updated_at":"2025-04-08T23:31:51.694Z","avatar_url":"https://github.com/TobseF.png","language":null,"readme":"# 📋 📘 Boostnote Markdown CheatSheet - Preview!\n\n\nThe missing markdown feature cheat sheet for [Boostnote](https://boostnote.io/).  \nIt tries to give a short summary of all formatting options which are available in Boostnote.\n\n---\n:warning: This is the **Preview Page** to see how it's rendered.\n\n:point_right: Open the [Cheat Sheet](BOOSTNOTE_MARKDOWN_CHEAT_SHEET.md) to see the code.\n\n:u5408: [Chinese Version](BOOSTNOTE_MARKDOWN_CHEAT_SHEET_zh_cn.md)\n\n---\n\n### :information_source: How to add it to Boostnote\n1. Open the [RAW](https://raw.githubusercontent.com/TobseF/boostnote-markdown-cheatsheet/master/BOOSTNOTE_MARKDOWN_CHEAT_SHEET.md) version of the cheat sheet. \n2. Copy it with \u003ckbd\u003ecrtl\u003c/kbd\u003e + \u003ckbd\u003ea\u003c/kbd\u003e and \u003ckbd\u003ecrtl\u003c/kbd\u003e + \u003ckbd\u003ec\u003c/kbd\u003e\n3. Create an empty _Markdown Note_ in Bosstnote paste it with  \n   \u003ckbd\u003ecrtl\u003c/kbd\u003e + \u003ckbd\u003eshift\u003c/kbd\u003e + \u003ckbd\u003ev\u003c/kbd\u003e  \n   (The *shift* is important to skip escaping)\n---\n\n\u003c!-- toc --\u003e\n\n- [Text Formatting](#Text-Formatting)\n  * [Emphasis](#Emphasis)\n  * [Abbreviation](#Abbreviation)\n  * [Superscript](#Superscript)\n  * [Link](#Link)\n  * [Check box](#Check-box)\n  * [Quotation](#Quotation)\n  * [Footnotes](#Footnotes)\n  * [Html](#Html)\n  * [Emoticons](#Emoticons)\n  * [Smart Arrows](#Smart-Arrows)\n  * [Keystrokes](#Keystrokes)\n  * [Source Code](#Source-Code)\n- [Structuring](#Structuring)\n  * [List](#List)\n  * [Definition list](#Definition-list)\n  * [Table](#Table)\n  * [Block](#Block)\n  * [Fold](#Fold)\n  * [Horizontal line](#Horizontal-line)\n  * [Admonition](#Admonition)\n- [Image](#Image)\n  * [Gallery](#Gallery)\n- [Latex](#Latex)\n- [Diagram Integrations](#Diagram-Integrations)\n  * [Flowchart](#Flowchart)\n  * [Sequence](#Sequence)\n  * [mermaid](#mermaid)\n  * [Chart](#Chart)\n  * [Ditaa](#Ditaa)\n  * [Plant UML](#Plant-UML)\n    + [Class Diagram](#Class-Diagram)\n    + [Activity Diagram](#Activity-Diagram)\n    + [Sequence Diagram](#Sequence-Diagram)\n    + [MindMap](#MindMap)\n    + [Work Breakdown Structure](#Work-Breakdown-Structure)\n    + [Gantt Diagram](#Gantt-Diagram)\n\n\u003c!-- tocstop --\u003e\n\n\u003e *Table of Contens generated by:*\n\u003e `Shortcut:` [[Shift]]+[[ctrl]]+[[T]]\n\u003e `Menu:`  _File / Generate / Update Markdown TOC_\n\n## Text Formatting\n\n### Emphasis\n*Italic type*  \n**Bold**  \n~~Negative~~  \n`highlighted`  \n\n### Abbreviation\n![mermaid](attachments/abbreviation.png?raw=true)\n\n### Superscript\n![mermaid](attachments/superscript.png?raw=true)\n\n### Link\n`Simple link`:  https://en.wikipedia.org/wiki/Microsoft_Notepad  \n`Named link`:   [Boostnote](https://boostnote.io)  \n`Tooltip link`: [Hover Me](https://boostnote.io \"A cool tooltip\")  \n`Auto linking`: [google.com](https://google.com)  \n`Jump to line`: [Go to line 200](:line:200)\n\n### Check box\n- [x] Task 1\n- [ ] Task 2\n\n### Quotation\n\u003e Quotation\n\u003e Quotation Quotation\n\n### Footnotes\nHere is a footnote reference, \u003csup\u003e[1](#myFootNote)\u003c/sup\u003e\nand another \u003csup\u003e[2](#anotherFootNote)\u003c/sup\u003e.\n\n### Html\n\u003cspan style=\"color:green\"\u003eGreen Text\u003c/span\u003e\n\u003cspan style=\"color:yellow\"\u003eYellow Text\u003c/span\u003e\n\u003cu\u003eunderlined\u003c/u\u003e\n\u003e HTML only works if you enable:\n\u003e Menu: _Preferences / Interface / Preview / Sanitization / Allow dangerous html tags_\n\n### Emoticons\nEmoji by shortcode: :books: :memo: :eyes:  \nEmoji by Unicode:   📚 📝 👀  \n[complete emojy list](https://www.webpagefx.com/tools/emoji-cheat-sheet/)\n\n### Smart Arrows\n--\u003e →  \n\u003c-- ←  \n\u003c-\u003e ↔  \n==\u003e ⇒  \n\u003c== ⇐  \n\u003c==\u003e ⇔  \n\n\u003e Smart arrows only work if you enable:  \n\u003e Menu: _Preferences / Interface / Preview / Sanitization / Convert textual arrows to beautiful signs_  \n\u003e ⚠ This will interfere with using HTML comments in your Markdown.\n\n### Keystrokes\n![latex](attachments/keystrokes.png?raw=true)\n\n### Source Code\n\n``` js\nRender: function () {\n  Return (\n    \u003cDiv className = “commentBox”\u003e\n      \u003cH1\u003e Comments \u003c/ h1\u003e\n      \u003cCommentList data = {this.state.data} /\u003e\n      \u003cCommentForm onCommentSubmit = {this.handleCommentSubmit} /\u003e\n    \u003c/Div\u003e\n  );\n}\n```\n\n## Structuring\n\n### List\n* List 1\n* List 2\n1. First ordered list item\n Second line\n2. Another item\n\n### Definition list\n\n![flowchart](attachments/definition_list.png?raw=true)\n\n### Table\n| Tables        | Are           | Cool  |\n| :------------ |:-------------:| -----:|\n| col 3 is      | right-aligned | $1600 |\n| col 2 is      | centered      |   $12 |\n| zebra stripes | are neat      |    $1 |\n|             |          Grouping           ||\n\n![flowchart](attachments/table.png?raw=true)\n\nMarkdown | Less | Pretty\n--- | --- | ---\n*Still* | `renders` | **nicely**\n1 | 2 | 3\n\n\u003e There must be at least 3 dashes separating each header cell.\nThe outer pipes (|) are optional, and you don't need to make the\nraw Markdown line up prettily. You can also use inline Markdown.\n\n### Block\n\tSome Infor First Line - Lorem ipsum dolor sit amet, consetetur sadipscing eli\n\tSome Infor Second Line - Lorem ipsum dolor sit amet, consetetur sadipscing eli\n\tSome Infor Third Line - Lorem ipsum dolor sit amet, consetetur sadipscing eli\n\n### Fold\n\u003cdetails\u003e\u003csummary\u003eBoostnote is a notepad corresponding to markdown notation, which is a tool for organizing and sharing information.\u003c/summary\u003e\n- Features - \u003cbr\u003e\n· Search function to find memos in one shot\n· Supports markdown notation \u003cbr\u003e\n· Support for Mac, Windows, Linux, iOS, Android \u003cbr\u003e\n· Export and import to Plain text (.txt), Markdown (.md) format \u003cbr\u003e\n· Supports PDF saving \u003cbr\u003e\n· Can be used offline \u003cbr\u003e\n· Synchronize to dropbox etc. with setting \u003cbr\u003e\n* Supports theme colors and numerous fonts\u003cbr\u003e\n\u003c/details\u003e\n\u003c/details\u003e\n\n### Horizontal line\nHorizontal lines have various ways of writing.\n* * *\n***\n---\n\n### Admonition\n\n![admonition](attachments/admonition.png?raw=true)\n\n## Image\n\n![images](attachments/images.png?raw=true)\n\n### Gallery\n\n![chart](attachments/gallery.png?raw=true)\n\n## Latex\n\n![latex](attachments/latex.png?raw=true)\n\n## Diagram Integrations\n\n### Flowchart\n\n![flowchart](attachments/flowchart.png?raw=true)\n\n### Sequence\n\n![sequence](attachments/ditaa_sequence.png?raw=true)\n\n### [mermaid](https://mermaidjs.github.io/)\n\n![mermaid](attachments/mermaid.png?raw=true)\n\n\n### Chart\n\n![chart](attachments/chart.png?raw=true)\n\n### [Ditaa](http://ditaa.sourceforge.net/)\n\n![ditaa 1](attachments/ditaa_1.png?raw=true)\n\n![ditaa 2](attachments/ditaa_2.png?raw=true)\n\n\n### [Plant UML](http://plantuml.com/)\n\n#### [Class Diagram](https://plantuml.com/class-diagram)\n![plantuml 1](attachments/plantuml_class_diagram.png?raw=true)\n\n#### [Activity Diagram](https://plantuml.com/activity-diagram-beta)\n![plantuml 2](attachments/plantuml_activity_diagram.png?raw=true)\n\n#### [Sequence Diagram](https://plantuml.com/sequence-diagram)\n![plantuml 3](attachments/plantuml_sequence_diagram.png?raw=true)\n\n#### [MindMap](https://plantuml.com/mindmap-diagram)\n![plantuml 4](attachments/plantuml_mindmap.png?raw=true)\n\n#### [Work Breakdown Structure](https://plantuml.com/wbs-diagram)\n![plantuml 5](attachments/plantuml_work_bbreakdown_structure.png?raw=true)\n\n#### [Gantt Diagram](https://plantuml.com/gantt-diagram)\n![plantuml 6](attachments/plantuml_gantt.png?raw=true)\n\n\n\n---\n\n\u003ca name=\"myFootNote\"\u003e1\u003c/a\u003e: Here’s one with multiple blocks.\n\n\u003ca name=\"anotherFootNote\"\u003e2\u003c/a\u003e: Subsequent paragraphs are indented to show that they belong to the previous footnote.\n","funding_links":[],"categories":["Others"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FTobseF%2Fboostnote-markdown-cheatsheet","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FTobseF%2Fboostnote-markdown-cheatsheet","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FTobseF%2Fboostnote-markdown-cheatsheet/lists"}