Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/dbkaplun/github-markdown-outline-extension

Displays a clickable outline/table of contents of all topic headers for markdown documents on Github
https://github.com/dbkaplun/github-markdown-outline-extension

Last synced: 19 days ago
JSON representation

Displays a clickable outline/table of contents of all topic headers for markdown documents on Github

Awesome Lists containing this project

README

        

Github Markdown Outline Extension
======
Displays a clickable outline of all topic headers for markdown documents on Github — *Install via [Chrome Web Store](https://chrome.google.com/webstore/detail/github-markdown-outline-e/gccinjjdbfdkkkebfbeipopijjfohfgj).*

![Screenshot](https://raw.githubusercontent.com/dbkaplun/github-markdown-outline-extension/master/screenshot.png)

## Installation

Install via [Chrome Web Store](https://chrome.google.com/webstore/detail/github-markdown-outline-e/gccinjjdbfdkkkebfbeipopijjfohfgj).

## Usage

When you visit any page with markdown on Github, this extension will automatically display a clickable outline near the top of the markdown document.

To see all available options, copy and paste the following URL into Chrome: `chrome://extensions/?options=gccinjjdbfdkkkebfbeipopijjfohfgj`

## Development

* `git clone [email protected]:dbkaplun/github-markdown-outline-extension.git`
* Go to `chrome://extensions` in Chrome
* Ensure the *Developer mode* checkbox is clicked
* Click the *Load unpacked extension...* button
* Select the `github-markdown-outline-extension` directory you just cloned
* Make sure the extension was added by refreshing this page