TopDocs 是一个开源的基于graphql、nuxtjs、mongodb、keystonejs的实时在线文档编辑系统,可用作各种在线文档编辑和展示,支持markdown语法。
其拥有动态实时编辑系统,移动优先,服务端渲染,针对SEO优化。适合小到大型项目的在线文档官网。
正巧我最近做博客,对文档工具有一些需求,所以搭建了这款开源的文档系统。
机器配置:1C-1G-1M
Ubuntu 18.04 实际操作:
1. 安装NodeJS
代码语言:javascript复制curl -sL https://deb.nodesource.com/setup_10.x | sudo -E bash -
sudo apt-get install -y nodejs
2.安装Mongodb
代码语言:javascript复制echo "deb [ arch=amd64 ] https://repo.mongodb.org/apt/ubuntu bionic/mongodb-org/4.0 multiverse" | sudo tee /etc/apt/sources.list.d/mongodb-org-4.0.list
sudo apt-get update
sudo apt-get install -y mongodb-org
sudo systemctl start mongod
mongo
use admin
db.createUser( { user: "admin", pwd: "<Enter a secure password>", roles: [ { role: "root", db: "admin" } ] } )
use topdocs
db.createUser( { user: "topdocs", pwd: "topdocs", roles: [ { role: "readWrite", db: "topdocs" } ] } )
exit
vim /etc/mongod.conf
<!-- append lines -->
security:
authorization: enabled
<!-- 退出编辑 -->
sudo systemctl restart mongod
3.安装topdocs:
代码语言:javascript复制curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | sudo apt-key add -
echo "deb https://dl.yarnpkg.com/debian/ stable main" | sudo tee /etc/apt/sources.list.d/yarn.list
sudo apt-get update && sudo apt-get install yarn
git clone https://gitee.com/quazero/topdocs
cd topdocs
yarn
4.反代绑定一个域名并且SSL之后,比如我绑定一个域名:docs.moejj.com,编辑index.js
代码语言:javascript复制const config = {
endpoint: 'http://127.0.0.1:3000/admin/api',
}
find endpoint
edit it
endpoint: 'https://docs.moejj.com/admin/api'
5.编译之后,开启应用:
代码语言:javascript复制yarn build
nohup yarn start &
exit
使用教程
开启之后,后台地址/admin ,密码为adminadmin,自己进后台修改。 设置中index中是首页的展示内容,需要注意的是:
代码语言:javascript复制-logo-/logo.png-logo-
-title-跨世代文档编辑系统-title-
-subtitle-实时动态markdown文档编辑系统,基于graqhql、mongodb、keystonejs、nuxtjs开发的移动优先的服务端渲染文档系统。-subtitle-
-button-查看文档$https://gitee.com/quazero/topdocs-button-
===header===
header下面就是完全的markdown语法的编写区域,编辑完成之后,首页可查看变化。
-logo-之间的是LOGO图片,可链接也可路径。
-title-之间的是首页展示大标题。
-subtitle-之间的是首页展示的项目介绍。
-button-是首页展示按钮需要的内容。其中<按钮名>$<链接>,链接可链接也可路径,按需更改。
===header===下面的就是正常的markdown语句,自己根据需要编写。