avonmoll / document-outline

Atom plugin for showing interactive document outlines

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Document Outline

Displays a hierarchical, interactive outline tree view of your document. This is particularly useful for working on long form documents such as academic papers and theses. Supports Markdown and Latex documents.

screenshot of document-outline

Usage

Trigger using document-outline:toggle or enable show by default setting. Single click to jump to heading in document, double click to collapse sub-headings.

Why?

It's easy to get lost working on long documents - an outline view is a huge help. However, the default atom navigator (and its symbol-tree-view outline sibling) don't handle markdown heading hierarchy and don't really make it possible to add in. Other projects with similar goals seem to be unmaintained and unmaintainable. Plus, thanks to the way we process markdown, we can enable unique features like drag-and-drop reordering of headings in the future.

See also

Some handy packages for working on long form markdown documents:

  • preview-inline (shameless plug) allows quick inline previews of LaTeX math equations and images in documents without having to generate a preview
  • language-pfm syntax highlighting for the pandoc variety of markdown
  • markdown preview plus enhanced HTML preview of markdown documents
  • build plus build-makefile. If you use Pandoc to build serious documents, your pandoc command starts to get pretty fancy. Do yourself a favour and write a makefile for that, then use atom-build to easily trigger building your document from the editor.

TODO

  • drag-and-drop reordering of headings
  • support for non-ATX headers in markdown

Contributions welcome!

About

Atom plugin for showing interactive document outlines

License:GNU General Public License v3.0


Languages

Language:JavaScript 90.9%Language:CSS 9.1%