# fluentmark

**Repository Path**: humphrey-gao/fluentmark

## Basic Information

- **Project Name**: fluentmark
- **Description**: 本地难以搭建，缺少net.certiv.dsl 0.6.0库，可以通过update site下载0.7.0库
- **Primary Language**: Unknown
- **License**: EPL-1.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-05-19
- **Last Updated**: 2021-05-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<img src="./doc/Logo110x80.png" alt="Logo"> 

# FluentMark

A full-featured Markdown editing environment for Eclipse.

## Features 

+ Standard Markdown syntax 
+ Extended syntax
	+ Html - inline & block
	+ Math - inline & block
	+ Latex - inline & block
	+ Graphs - [Graphviz Dot](http://www.graphviz.org/) language block
	+ Uml - [PlantUml](http://www.graphviz.org/) language block 
+ Liveview - real-time external browser rendered preview
    - reactive rendering using [Vue.js](https://vuejs.org/)
    - math presentation using [MathJax](https://www.mathjax.org/)
    - code highlighting using [highlightjs](https://highlightjs.org/)
+ Spell check with quick-assist correction processor
+ Smart editing behaviors, including intelligent paragraph, list & blank line handling
+ Table editor
+ Text, list and table formatter
+ Stylesheet controlled editor presentation
+ Outline view with drag-and-drop support

## Use

[How to Use](https://github.com/grosenberg/Fluentmark/blob/master/doc/Use.md)

## Screenshot

<figure>
	<a href="https://github.com/grosenberg/Fluentmark/blob/master/doc/ScreenShot.png" target="_blank">
		<img src="./doc/ScreenShot.png" alt="screen shot" width=600>
	</a><p>
  <figcaption>Graph presentation using Graphviz Dot (old version)</figcaption>
</figure>


## Installation 

Installation:

Certiv Tools update site: `https://www.certiv.net/updates`

Requirements

- Eclipse 2021-03
- JDK 11+

Requirements for Dot and PlantUml language blocks

- [Graphviz](http://www.graphviz.org/download.php). 


Requirements for Html and Pdf export

- [Pandoc](https://pandoc.org) and a _LaTeX_ processor (Pandoc recommends [*MikTeX*](https://miktex.org/)).


## Configuration

Eclipse Preference pages ---

> `Window` -> `Certiv Tools` -> `FluentMark`

To use the Pandoc converter, select the `pandoc` executable from the local filesystem 
on the Pandoc Converter tab. 

To use Graphviz Dot, select the `dot` executable on the Fluentmark preference page.  
If `Graphviz` is installed in a non-default directory, PlantUML requres that the 
`GRAPHVIZ_DOT` environment variable be set to the actual installation directory.

To use the BlackFriday converter, install the customized 
[blackfriday-tool](https://github.com/grosenberg/blackfriday-tool) from GitHub. 
A Windows 64-bit compiled executable is available for download
[blackfriday-tool.zip](http://www.certiv.net/updates/net.certiv.fluentmark.site/blackfriday-tool.zip). 
The `blackfriday-tool` executable can then be selected on the BlackFriday Converter tab.


## Support

Open an [issue on Github](https://github.com/grosenberg/fluentmark/issues). Provide 
as much information as possible

- a minimal Markdown document that demonstrates the issue 
- OS name and version version 
- the error message encountered 

## Resources

1. Markdown Syntax
    - [Pandoc's Markdown Documentation](https://pandoc.org/MANUAL.html#pandocs-markdown)
    - [CommonMark Spec 0.29](https://spec.commonmark.org/0.29/)
1. [TeX Syntax Documentation](https://www.onemathematicalcat.org/MathJaxDocumentation/TeXSyntax.htm)
    - [Templates](https://github.com/topics/latex-template "Latex Templates") for PDF generation
1. [PlantUML Language Specification](https://plantuml.com/sitemap-language-specification)
    - [Ashley’s PlantUML Documentation](https://plantuml-documentation.readthedocs.io/en/latest/index.html)
    - [C4 Model for Software Architecture Diagrams](https://github.com/plantuml-stdlib/C4-PlantUML)
1. [Graphviz Documentation](https://www.graphviz.org/documentation/)
    - [Arrow Shapes](https://www.graphviz.org/doc/info/arrows.html)
    - [Node Shapes](https://graphviz.org/doc/info/shapes.html)
    - [Dot Manpage](http://www.graphviz.org/pdf/dot.1.pdf)

## License

EPL