Live Editor¶
What this is¶
Philosophy¶
The point of MkDocs Tau Delta is to make Markdown the language of choice
among engineers writing documentation.
An additional goal is to address a larger group of users beyond the ones creating documentation. If meeting minutes, roadmaps, speeches, presentation notes could be created on-the-fly and saved to a site where stakeholders can read and contribute to the documents easily, then senior engineers, team leads and project/product/department managers would become part of the target audience, leading to significantly increased product proliferation.
Success depends on at least four factors:
- richness of features
- quality, both functionally and aesthetically
- ease of setup
- ease of use
This section is an attempt to improve the ease of use through the cunning use of a free live editor, which is naturally not a part of the project.
Requirements¶
The ideal set of features is:
- edit Markdown documents in a
free,ad-free,clutter-freesplit-screen editor and preview web app - open Markdown documents directly from an MkDocs Tau Delta enabled repository
- save Markdown documents directly to an MkDocs Tau Delta enabled repository
- continuously synchronize with the persistent document source while editing
This would enable the use of Markdown for note-taking as well as for documentation.
Proposed software¶
StackEdit¶
StackEdit is a full-featured, open-source Markdown editor based on PageDown, the Markdown library used by Stack Overflow and the other Stack Exchange sites.
It is an open source project. Its repository can be found here. Its web application can be found here.
Dillinger¶
Dillinger is a cloud-enabled, mobile-ready, offline-storage, AngularJS powered HTML5 Markdown editor.
It is an open source project. Its repository can be found here. Its web application can be found here.
Todo
Test integration and synchronization with Google Drive and GitHub.
Explore viability of connection with GitLab.
Converting existing HTML content to Markdown¶
Pandoc¶
Pandoc is a Haskell library for converting from one markup format to another, and a command-line tool that uses this library.
It is an open source project. Its repository can be found here. Its web application can be found here. Its website can be found here.
Turndown¶
Turndown is an HTML to Markdown converter written in JavaScript.
It is an open source project. Its repository can be found here. Its web application can be found here.
It also has a GitHub Flavored Markdown plugin that can be found here.
WordPress theme with Markdown support¶
Jetpack¶
From the website:
Browse hundreds of professionally-designed WordPress themes to find the right one for your site.
Customize your homepage, blog posts, sidebars, and widgets — all without touching any code.
Seamlessly embed rich content and videos, deliver them all at high speed, and replace default search with an Elasticsearch-powered service.
An article about Markdown support can be found here.