Github List Markdown



Latest version
  • GitHub uses what were calling GitHub Flavored Markdown (GFM) for messages, issues, and comments. It differs from standard Markdown (SM) in a few significant.
  • :pencil: Markdown code for lots of small badges:ribbon::pushpin: (shields.io, forthebadge.com etc):sunglasses. Contributions are welcome! Please add yours!

Apr 18, 2021 List of markdown presentation tools. GitHub Gist: instantly share code, notes, and snippets.

Released:

Autogenerated Table of Contents for Github Markdown or Bear Notes

Project description

Generated by the script ;)

Table of Contents

  • Installation
  • Usage

Overview

I love using Bear Notes for note taking of all sorts. Recently, Bear released a feature that allowed headers to be linked with x-callback-urls. And thus, I created a script to autogenerate a Table of Contents for your notes based on the headers.

Installation

NOTE: This program is only compatible with Python 3.x

PyPi (Preferred)

Manually

Usage

Flags

  • -h or --header-priority is the Limiting Header Priority/Strength (whether you limit your Table of Contents to h3s or h4s)
  • -t or --type is the type of anchor you want to use (Github or Bear x-callback-url)
  • --no-write is a flag on whether you want to disable the feature that automatically injects the ToC into your Markdown file or Bear Note
  • -toc or --table-of-contents-style is the Markdown style for your Table of Contents header

With Bear

  • Add a Table of Contents to a Bear Note with the title 'Bear Note Title'

  • Add a Table of Contents to a Bear Note with the UUID 20703126-FA33-400A-B98E-F55F57E3EF48-47683-000143B2335758CA

  • Add a Table of Contents to two Bear Notes with titles 'Bear Note Title 1' and 'Bear Note Title 2'

  • Add a Table of Contents to all Bear Notes that contain the tag #bear OR tag #beet

  • This allows you to take input a list of Bear Note titles, tags, or UUIDs and will inject the ToC into your note whether or not you submit the --no-write flag.
  • If you have #tags at the top of your note (cause I use them to categorize my notes), it will inject the ToC right after any tags.
Original NoteNote with ToC

With Markdown Files

  • Add of a Table of Contents to README.md (Using Github Anchors)

  • Add of a Table of Contents to README.md and Folder/README2.md (Using Github Anchors)

Release historyRelease notifications | RSS feed

1.2.6

1.2.4

1.2.3

1.2.2

1.2.1

1.2.0

Github markdown list links

1.1.3

1.1.2

1.1.1

1.1

1.0.1

All that remains free mp3 download. 1.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for markdown-toc, version 1.2.6
Filename, sizeFile typePython versionUpload dateHashes
Filename, size markdown_toc-1.2.6-py3-none-any.whl (8.1 kB) File type Wheel Python version py3 Upload dateHashes
Filename, size markdown-toc-1.2.6.tar.gz (6.7 kB) File type Source Python version None Upload dateHashes
Close

Hashes for markdown_toc-1.2.6-py3-none-any.whl

Hashes for markdown_toc-1.2.6-py3-none-any.whl
AlgorithmHash digest
SHA25663706ab4ccde4c82840f79197cefbcf47dc2a25582cf86187a83a9206cb38345
MD50a26caf18733825b613c1496e3eb9025
BLAKE2-256869ba2ef42a5a1bcba508afec04da982839681ee62fa9dded969692f3cbb7ae7
See full list on github.comClose

Hashes for markdown-toc-1.2.6.tar.gz

Hashes for markdown-toc-1.2.6.tar.gz
AlgorithmHash digest
SHA2568e89536688000c05b329df220e8036211c572af376cc83cee8763335711c19bd
MD575e97adc1fb83b8a394d91536ff05647
BLAKE2-256222ea41b4efe2ffab22e7f1aeba325fb843117dce9386530ba7efa89c5c14b96

Even with a markup language as simple as Markdown, it is nice to have an editor that complements the language. I use Markdown frequently to write posts on my websites along with writing documentation when developing software. I’ve used many of these following editors and I am sure we will have a different opinion on which one is the best. I’ve also tried many other editors that I couldn’t care enough about to even mention here.

ghostwriter

ghostwriter is my favorite Markdown editor. It provides a very simple interface and allows you to type in Markdown without acting like a traditional word processor. Markdown is simple and ghostwriter knows it. There is no need for buttons that format text, instead it displays the syntax you type and provides a preview window and spell checker.

ghostwriter displays the Markdown syntax uniquely. The language syntax is still displayed in the editor but the content is stylized with different colors, larger fonts for headers, and a mono spaced font for code blocks. The unique display of the syntax makes it easy to identify parts of your document without having to use a preview pane.

An additional feature many will find joy in are the different themes that come packed with the program. The editor can be customized easily from predefined themes, or you could create your own quickly.

Formiko

Formiko offers a simple user interface for previewing and writing Markdown files. There isn’t much to say about this basic editor, but I’ve used it in the past and thought someone may like it more than the other items in this list. Formiko offers spell checking, editor syntax highlighting, and a preview pane. The editor resembles gedit and other basic editors packaged with Linux.

ReText

ReText is a reStructuredText editor that also supports Markdown. The editor provides the user with a lot of options to customize the program, but many of the options have to be edited in a configuration file. The color scheme of the program can be modified, but you have to jump through a few hoops to actually get it working. GeekThis actually has a post on how to change the ReText color scheme.

ReText is a fairly generic editor but stands out by allowing the user to extend the Markdown syntax by importing third party extensions. Other than that, the generic features of spell checking, preview pane, and editor syntax highlighting all exist.

Typora

Typora is marketed as a truly minimal Markdown editor. The editor masks the Markdown syntax and instead renders the text inside the editor, similar to what you see with word processors. Typora provides a few usability features such as a file tree with third-party support. Document stats are available that show word count, time to read, and the number of lines written.

Markdown

How To Write An Ordered List Which Contains Nested Unordered ..

Typora is going to be a premium editor, but during the beta it is free to use. It’s easy to see why the creators want to charge for the program as it provides a unique editor, has lots of features, and is supported on multiple operating systems.

StackEdit

For an online editor, StackEdit is by far the most popular. The editor provides all of the features desktop editors have but also works without the need to install anything.

StackEdit provides lots of integration with other services. You can modify documents you have stored on Blogger, Google Drive, Dropbox, Github, and more. If you mainly want an editor for one of those services, StackEdit can help you skip the syncing step.

My main critique of StackEdit is that saving and opening local files is cumbersome. If you need to edit multiple local files and switch between documents frequently, StackEdit will slow you down.

Dillinger

Github list markdown download

Github Markdown Indent

Dillinger is an online Markdown editor. It offers many of the features you expect in an editor but sadly lacks a spell checker which is weird since it’s a browser based editor. Unlike StackEdit, it is easy to edit and save local files. Dillinger also allows you to link your Google, Github, One Drive, Medium, and Dropbox account to the editor.

If it weren’t for the lack of a spell checker, I would probably frequent Dillinger when working from my Chromebook. If you don’t require a spell checker, Dillinger is nice since it allows you to export documents as PDF for free, it is always available online, and it can connect to third party services.

MarkdownPad

MarkdownPad is the feature packed Markdown editor for Windows. There is a free and Pro version of the program, with the Pro version offering many features that other editors on this list do not support. With MarkdownPad Pro you get syntax highlighting of code blocks, PDF exporting, and session management.

The free version does limit the Markdown syntax slightly by not parsing pipe tables and doesn’t support Github based Markdown. The free version also limits the number of open documents which can be a bit annoying. Luckily you can try the program for free to see if it’s worth your money if you’re looking for a feature rich Markdown editor for Windows.

Markdown Edit

Markdown Edit is a minimalist editor for Windows. The editor doesn’t show you tool and status bars, but instead focuses on the editor and preview pane. Although the editor is minimalist it does provide a lot of features for free.

There Could Be A Work Around That I Usually Use When We Want The List In Md Files. I Wrap Them As Shown Below: Copy Paste This Below Code In Markup..

The editor supports equation markup, drag and drop images, export to Word and PDF, keyboard shortcuts, and spell checking. The program can be customized to use different colors, fonts, and themes. The program is also an actual program and not a Windows Store App which will excite quite a few people.

Editor Comparison

Below is a table comparing basic features across the editors listed above. The table might be outdated as many of these editors are open source and are actively being updated.

Github Nested List Markdown

EditorSystemSpell CheckThemesExport
ghostwritercross platformyesyeshtml
Formikocross platformyesnohtml
ReTextcross platformyesyeshtml, extensions
Typoracross platformyesyespdf, docx, odt, Epub
StackEditonlinebrowsernohtml, pdf (membership)
Dillingeronlinenonohtml, pdf
MarkdownPadWindowsyesyeshtml, pdf
Markdown EditWindowsyesyeshtml, docx, pdf