2 Star 50 Fork 8

屈阿零 / TopDocs

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
MIT

一个开源的基于graphql、nuxtjs、mongodb、keystonejs的实时在线文档编辑系统,可用作各种在线文档编辑和展示,支持markdown语法。 如果觉得麻烦可直接使用企萌网:https://www.iqi360.com ,两分钟即可构建出项目官网,多人共同编辑添加文档,添加开发路线图,并且拥有全文搜索功能。

图示

首页 内页 移动端展示

差异化功能

动态实时编辑系统,移动优先,服务端渲染,针对SEO优化。适合小到大型项目的在线文档官网。

更新日志

2020年9月26日 添加自动更新库的工具,使用方式:

yarn upgrade @keystonejs

运行之后会自动更新keystone的库至最新版,可以解决版本引起的运行错误问题。

2020年8月30日 将所有库升级成最新版,修复无法启动和安装的问题。

2020年6月18日 分类最后一个文档可下翻到下一个分类的第一个文档。 支持了分类第一个文档可上翻到上一个分类的最后一个文档。

安装方法

Ubuntu 18.04 : nodejs安装

curl -sL https://deb.nodesource.com/setup_10.x | sudo -E bash -
sudo apt-get install -y nodejs

mongodb安装

sudo apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv 9DA31620334BD75D9DCB49F368818C72E52529D4
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

安装topdocs:

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

反代绑定一个域名并且SSL之后,比如我绑定一个域名:docs.moejj.com,新建.env

ENDPOINT=https://docs.moejj.com/admin/api
MONGOURI=mongodb://topdocs:topdocs@127.0.0.1:27017/topdocs
COOKIESECRET=thisismysecretcookies

编译之后,开启应用:

yarn build
export NODE_ENV=production
nohup node server.js &
exit

需要注意

开启之后,后台地址/admin,账号为admin@admin.com,密码为adminadmin,自己进后台修改。 设置中index中是首页的展示内容,需要注意的是:

-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语句,自己根据需要编写。

MIT License Copyright (c) 2019 屈阿零 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

简介

graqhql/mongodb/nodejs/nuxtjs开源跨世代实时在线文档编辑系统 展开 收起
JavaScript
MIT
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
JavaScript
1
https://gitee.com/quazero/topdocs.git
git@gitee.com:quazero/topdocs.git
quazero
topdocs
TopDocs
master

搜索帮助

14c37bed 8189591 565d56ea 8189591