search

winterstein / Eclipse-Markdown-Editor-Plugin

Adds Markdown text editing support to Eclipse
Eclipse Public License 1.0
297 stars 73 forks source link

readme

Eclipse Markdown Editor Plugin

Build Status <a href="http://marketplace.eclipse.org/marketplace-client-intro?mpc_install=369" title="Drag and drop into a running Eclipse toolbar area to install Markdown Text Editor">

Edit .md and .txt files with syntax highlighting.
Provides Outline and Preview HTML views.

Please see the website for information: http://www.winterwell.com/software/markdown-editor.php

Eclipse Marketplace entry: http://marketplace.eclipse.org/content/markdown-text-editor
or install with Nodeclipse CLI Installer nodeclipse install markdown

There is also a complementary GitHub Flavoured Markdown Viewer https://github.com/satyagraha/gfm_viewer

For dedicated AsciiDoc (.adoc) support, see https://github.com/de-jcup/eclipse-asciidoctor-editor

Usage

Note that for HTML preview OS the internal browser is used, e.g. Internet Explorer on Windows; if you use Ubuntu or other Linux distros, we recommend the WebKit browser; see:

Eclipse Dev Details

You need Eclipse with PDE, e.g. Eclipse Standard

Main Editor class winterwell.markdown.editors.MarkdownEditor defined as

  <editor
        name="Markdown Editor"
        extensions="txt,md"
        icon="icons/notepad.gif"
        contributorClass="winterwell.markdown.editors.ActionBarContributor"
        class="winterwell.markdown.editors.MarkdownEditor"
        id="winterwell.markdown.editors.MarkdownEditor">
  </editor>

Build

mvn package

then check site\target directory for update site archive markdown.editor.site-x.x.x.zip and p2 repository. Use Help -> Install New Software... -> Add... -> Archive to istall from .zip file.

Increase version

mvn -Dtycho.mode=maven org.eclipse.tycho:tycho-versions-plugin:set-version -DnewVersion=1.2.0-SNAPSHOT

History

with-Eclipse logo