# markdown2html

**Repository Path**: WD_MoonMoonBird/markdown2html

## Basic Information

- **Project Name**: markdown2html
- **Description**: Markdown2HTML 是 Java 实现的 Markdown 转 HTML 文档的工具，底层使用 MarkdownJ.
- **Primary Language**: Java
- **License**: BSD-3-Clause
- **Default Branch**: master
- **Homepage**: https://www.oschina.net/p/markdown2html
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 2
- **Created**: 2021-12-02
- **Last Updated**: 2024-10-13

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

Markdown2HTML
=============

An extremely simple Markdown to HTML converter,
powered by [MarkdownJ](http://code.google.com/p/markdownj/).

Available in command line and GUI mode.

It is licensed under the BSD license.


Requirements
------------

You need Java JVM 1.6 or newer installed on your machine.


Usage
-----

### GUI version ###

`java -jar Markdown2HTML.jar`

### Command line version ###

`java -jar Markdown2HTML.jar markdownFile [- header headerFile.html] [-footer footerFile.html] [-out [file.html]]`

#### Options for the command line version ####

- `markdownFile`: the text file which will be converted (compulsory field).
- `-header headerFile.html`: the path of an existing HTML header file.
Its content will be prepended to the converted `markdownFile` file.
- `-footer footerFile.html`: the path of an existing HTML footer file.
Its content will be appended to the converted `markdownFile` file.
- `-out`: enter this to specify that the program should create a new file
which contains the same name as the `markdownFile`, with the .html extension.
- `-out file.html`: enter this to specify the name of the converted file.


GUI Screenshot
--------------

<img src="https://raw.githubusercontent.com/Nilhcem/markdown2html/master/screenshot.png" width="814" height="564" />


Building it
-----------

`mvn package`, that's all!