https://github.com/madflow/flow-netbeans-markdown

Markdown file support for the NetBeans IDE
https://github.com/madflow/flow-netbeans-markdown

ide java markdown netbeans plugin

Last synced: about 2 months ago
JSON representation

Markdown file support for the NetBeans IDE

• Host: GitHub
• URL: https://github.com/madflow/flow-netbeans-markdown
• Owner: madflow
• License: mit
• Created: 2011-07-18T19:00:32.000Z (over 13 years ago)
• Default Branch: nb8
• Last Pushed: 2018-01-28T13:55:39.000Z (almost 7 years ago)
• Last Synced: 2024-08-05T11:12:43.031Z (5 months ago)
• Topics: ide, java, markdown, netbeans, plugin
• Language: Java
• Homepage:
• Size: 3.64 MB
• Stars: 280
• Watchers: 23
• Forks: 41
• Open Issues: 23
• Metadata Files:
  • Readme: Readme.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-netbeans - Flow NetBeans Markdown - Works with NetBeans 12.3 but it's currently being reworked in this other [repo](https://github.com/jkost/MarkdownViewerForNetBeans). (:electric_plug: Plugins <a name="plugins"></a> / Language Support)

README

        
A NetBeans IDE plugin which adds Markdown support. This plugin provides basic syntax highlighting, HTML preview and HTML export when editing a Markdown document.

# What is Markdown?

> Markdown is a text-to-HTML conversion tool for web writers. Markdown allows you to write using an easy-to-read, easy-to-write plain text format, then convert it to structurally valid XHTML (or HTML).

Source: 

# Installation

The plugin is [available](http://plugins.netbeans.org/plugin/50964/markdown-support) in the official NetBeans Plugin Portal Update Center.

You can also download a pre-packaged release:

 - https://github.com/madflow/flow-netbeans-markdown/releases (list of all releases)

 - https://github.com/madflow/flow-netbeans-markdown/releases/download/2.3.1/flow-netbeans-markdown.nbm (**note:** version 2.3.1)

Install the plugin with: `Tools -> Plugins -> Downloaded`

You may also compile a binary yourself with the **latest development code**.

 1. git clone git://github.com/madflow/flow-netbeans-markdown.git

 2. Open the folder with NetBeans (Open Project)

 3. (Configure Target Platform if needed)

 4. Choose "Create NBM" from the project menu

 5. Install the plugin with: Tools -> Plugins -> Downloaded

# Requirements

- NetBeans >= 8.0

- "NetBeans Plugin Development" plugin must be installed if you want to compile your own binary package.

# Plugin features

- Adds Markdown to your "New File" wizard

- Provides basic syntax highlighting

- Provides code folding based on headers

- Provides bread crumbs in the editor based on headers

- Provides a table of contents in the Navigator window

- Enables full fledged preview in the editor window

- Exports your saved file content to an HTML document

- Enables HTML preview of your saved file in your configured web browser

- Lets you customize the HTML output with CSS and alien intelligence (Options->Miscellaneous->Markdown->HTML Export)

- Supports multiple extensions over standard markdown (see [PegDown][], Options->Miscellaneous->Markdown->Extensions)

- Supports auto operations(additoin and removal) for lists (Options->Miscellaneous->Markdown->Miscellaneous)

# Screenshots

![Editor - Source view](editor-source.png "The Source view of the Markdown editor")

***

![Editor - Preview view](editor-preview.png "The Preview view of the Markdown editor")

# Resources

- [PegDown][] : A pure-Java Markdown processor based on a parboiled PEG parser supporting a number of extensions.

- http://daringfireball.net/projects/markdown/ : Home of the Markdown (Basics, Syntax)

- http://openiconlibrary.sourceforge.net/ : Icons

- [Markdown Mark][mdmark] : A graphic element to identify Markdown files created by [Dustin Curtis][dcurtis] ([Github repo][mdmark-gh])

[dcurtis]: http://dustincurtis.com/

[mdmark]: http://dcurt.is/the-markdown-mark

[mdmark-gh]: https://github.com/dcurtis/markdown-mark

[pegdown]: https://github.com/sirthias/pegdown