mdwiki api文档编辑器使用

mdwiki api文档编辑器使用

欢迎大家关注我的个人博客

Step one

环境要求

1. Install node.js >= 0.10 and npm (if not included)

  a. 克隆项目地址mdwiki

  b. git clone https://github.com/Dynalon/mdwiki.git 到你存放网站项目的文件夹下

  c. 执行 make命令

Step two

1. 配置本地服务器(linux-nginx-php56)

  我本地用的nginx服务器，这里稍微介绍下配置。

  进入到nginx的服务器配置路径 /usr/local/etc/nginx/servers 创建一个mdwiki.default.conf文件，内容如下:

server {

    listen       80;
    server_name   api.mdwiki.local(举个例子);
    root   /your_www_path/mdwiki/dist/;


    location / {    
            index  index.html index.htm index.php;
            try_files $uri $uri/ /index.php?$args;
    }

    error_page   500 502 503 504  /50x.html;
    location = /50x.html {
            root   html;
    }

     location ~ \.php$ {
                fastcgi_pass   127.0.0.1:9000;
                fastcgi_index  index.php;
                include        fastcgi.conf;

            }
}   

执行 sudo nginx -t 检查语法,成功之后启动（或者重启）sudo nginx (sudo nginx -s reload)

  然后在本地hosts文件添加上述域名
cd /etc/hosts 添加 127.0.0.1 api.mdwiki.local

2. mdwiki配置

  创建一个首页的md文件，比如index.md,然后按照http://api.mdwiki.local/mdwiki.html#!index.md的形式请求数据。

  上述配置完成之后直接输入网页会报错, 需要添加config.json 和 navagation.md 等配置文件

config.json文件内容配置如下:

{
  "useSideMenu": true,
  "lineBreaks": "gfm",
  "additionalFooterText": "",
  "anchorCharacter": "⚓",
  "title": "MDwiki - Markdown based wiki done 100% on the client via javascript"
}

navagation.md配置按照官方文档配置即可

  然后你就可以在刚才创建的index.md中愉快的写markdown了。如果觉得样式不好看可以在我的项目中把mdwiki.html复制下来

写在最后

  不清楚markdown语法的可以移步这里,或者Markdown指南