# MarkdownViewTool

**Repository Path**: andrew_song/MarkdownViewTool

## Basic Information

- **Project Name**: MarkdownViewTool
- **Description**: Markdown API tool是一款把Markdown格式的文档转换为HMTL文本,并且实现在线预览的功能
- **Primary Language**: Java
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2018-09-04
- **Last Updated**: 2022-06-24

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

[TOC]

# 欢迎使用Markdown API

**Markdown API tool**是一款把Markdown格式的文档转换为`HMTL`文本,并且实现在线预览的功能


## 我为什么要用Markdown API

- 摆脱束缚 和附件传输说再见，一次上传，到处预览
- 实时查看 更新文档后实时更新，不再担心他人看不到、看错，比别人更快一步
- 轻松编写 Markdown易读易写，自带光环


## 什么是Markdown

> Markdown 是一种轻量级标记语言，它允许人们使用易读易写的纯文本格式编写文档，然后转换成格式丰富的HTML页面。    
—— [维基百科](https://zh.wikipedia.org/wiki/Markdown)

## Markdown常用语法

### 标题

标题能显示出文章的结构。行首插入1-6个 # ，每增加一个 # 表示更深入层次的内容，对应到标题的深度由 1-6 阶。

- H1 :# Header 1
- H2 :## Header 2
- H3 :### Header 3
- H4 :#### Header 4
- H5 :##### Header 5
- H6 :###### Header 6

### 文本样式

- 链接 :`[Title](URL)`
- 加粗 :**Bold**
- 斜体字 :*Italics*
- 高亮 :==text== `==你的文字==`
- 段落 : 段落之间空一行
- 换行符 : 一行结束时输入两个空格
- 列表 :* 添加星号成为一个新的列表项。
- 引用 :> 引用内容
- 内嵌代码 : `alert('Hello World');`
- 画水平线 (HR) :--------

### 图片

使用Markdown将图像插入文章，你需要在Markdown编辑器输入 `![]() `  
比如：  
![image](https://f11.baidu.com/it/u=3388563262,3719948374&fm=72)


### 更多教程

[更多教程,请点我](http://www.markdown.cn/)  

## Markdown API使用说明

### 简单配置

如下图所示,分别配置：
1. welecome 配置欢迎语
2. path 存放文章的根目录

![image](http://p5in4o880.bkt.clouddn.com/config.jpg)

### 首页说明

![image](http://p5in4o880.bkt.clouddn.com/index.jpg)


### 体验地址

[点我体验在线API](http://api.loveyy.net)

## 作者博客

[燕良山好汉的博客](http://loveyy.net)