# mdserver

**Repository Path**: simbory/mdserver

## Basic Information

- **Project Name**: mdserver
- **Description**: the mdserver is a markdown document server written in GO language
- **Primary Language**: Go
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2017-09-27
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

## mdserver

the mdserver is a markdown document server written in GO language

### 1. pre-requisites

The tool `go-bindata` is used to convert any file into managable Go source code. In this project, it is used to pack the resource files(js,css,favicon & GO template file) into the executable program file to make the deployment more easily. You can run this command to get this tool:
```
 > go get github.com/jteeuwen/go-bindata
```

The package `blackfriday` is a markdown processor implemented in GO. In this project, it is used to convert markdown code to HTML. Run this command to get the package:
```
> go get github.com/russross/blackfriday
```

### 2. how to build the project
```
> git clone https://gitee.com/simbory/mdserver
> cd mdserver
> go-bindata ./mdserver-resources/...
> go build
```

### 3. how to use it. 

* create a empty folder
* copy the `mdserver.exe` into this folder
* create the file `index.md` in this folder(`index.md` is the default page)
* run command `mdserver.exe -addr=":8888" -dev=true`.
* `-addr`: the address & port that the mdserver is running on.
* `-dev`: true: run as the development mode. When the markdown file is changed, the page in browser will be refreshed automatically.
            false: run as the production mode. the page in browser will not be refreshed if the markdown file is changed.