Markdown Book

node vuejs

简介

轻快，简洁，易用， Node + Vuejs + CodeMirror 开发的Github Flavored Markdown Editor + 微博客预览。

基于github api 数据接口，markdown文档直接同步到repository 实时预览+实时更新 打造 serverless 轻应用

考虑到数据安全 github授权api拒绝cros请求。若需要在线文档编辑功能，授权服务器搭建必不可少

快速部署

github账号设置

Settings -> Developer settings
新建一个 GitHub Apps 用于普通用户授权 install 公开仓库 权限包括可读、可提交issue comment
新建一个 OAuth Apps 用于管理员授权 权限包括读写所有仓库 repo
新建一个 Personal access tokens 用于无登陆用户 权限只读 不用勾选任何选项 此token将公开 切勿打开多余权限

项目配置 github.config.js

module.exports = {
   owner: "XX", //github账号名称
   defaultRepoKey: "s", //默认页面访问前缀
   repos: {
       //key为访问前缀 至少有一个repo
       "s": {
           name: "gitbook", // repository 名称
           scope: "public",//public/private(管理员可见)
           type: "article", //类型 ariticle/note
           index: "/README.md"  //首页
       }
   },
   publicToken : "", //readonly 无登录用户只读public仓库
   oauthAppsClientId: "", //管理员授权 读写所有仓库
   githubAppsClientId: "", //普通用户授权 可提交issue comment 至install的仓库
   authorizeUrl: "" //授权服务器地址 需要支持oauth 和 githubapp 成功后重定向至redirectUrl
}

授权服务器代码php示例

<?php
	 $ch = curl_init();
    curl_setopt($ch, CURLOPT_URL, 'https://github.com/login/oauth/access_token');
        curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
        //管理员写入需要用到一个oauth应用
    if(!empty($_GET['client_id']) && $_GET['client_id'] == '<github oauth client_id>'){
        $post = [
            'client_id' =>  '<github oauth client_id >',
            'client_secret' => '<github oauth client_secret>',
            'code'   => $_GET["code"] ?? '',
            'redirect_uri' => "<回调此接口的完整路径>",
            'state' => $_GET["state"] ?? '' 
        ];
    }
    else{
          //普通用户读取公开仓库需要一个githubapp应用 并install 该数据仓库
        $post = [
                    'client_id' => '<githubapp client_id >',
                    'client_secret' => '<githubapp client_secret >',
                    'code'   => $_GET["code"] ?? '',
                    'redirect_uri' => "<回调此接口的完整路径>",
                    'state' => $_GET["state"] ?? ''
                ];

    }
        curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
        curl_setopt($ch, CURLOPT_POSTFIELDS, $post);
 
        $result = curl_exec($ch);
        $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
    if (curl_errno($ch)) {
         echo 'Error: ' . curl_error($ch);
         exit;
    }
    $http_status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
    curl_close($ch);

    if(!empty($_GET["redirect_uri"])){
        if(strpos($_GET["redirect_uri"], '?') !== false){
            $url = $_GET["redirect_uri"] . "&" . $result;
        }
        else{
            $url = $_GET["redirect_uri"] . "?" . $result;
        }
    }
    
    header("Location: $url");