All Projects → yybawang → Adoc

yybawang / Adoc

📄🖊轻松的的 API MD文档编写工具

Projects that are alternatives of or similar to Adoc

Wizard
Wizard是一款开源的文档管理工具,支持Markdown/Swagger/Table类型的文档。
Stars: ✭ 1,733 (+1783.7%)
Mutual labels:  api, doc, markdown
Kodexplorer
A web based file manager,web IDE / browser based code editor
Stars: ✭ 5,490 (+5867.39%)
Mutual labels:  doc, markdown
Verb
HEADS UP! Verb is going though a major transition, we've completely refactored everything from the ground up. If you're interested, please see the dev branch.
Stars: ✭ 442 (+380.43%)
Mutual labels:  api, markdown
Gotenberg Go Client
Go client for the Gotenberg API
Stars: ✭ 35 (-61.96%)
Mutual labels:  api, markdown
Docfx
Tools for building and publishing API documentation for .NET projects
Stars: ✭ 2,873 (+3022.83%)
Mutual labels:  api, markdown
Docma
A powerful tool to easily generate beautiful HTML documentation from JavaScript (JSDoc), Markdown and HTML files.
Stars: ✭ 287 (+211.96%)
Mutual labels:  api, markdown
Ui
UI for https://www.apibuilder.io
Stars: ✭ 8 (-91.3%)
Mutual labels:  api, apidoc
Gulp Apidoc
📄 RESTful web API Documentation Generator
Stars: ✭ 60 (-34.78%)
Mutual labels:  api, apidoc
Parse Comments
Parse JavaScript code comments. Works with block and line comments, and should work with CSS, LESS, SASS, or any language with the same comment formats.
Stars: ✭ 53 (-42.39%)
Mutual labels:  apidoc, markdown
Vuesence Book
Minimalistic Vue.js based documentation system component
Stars: ✭ 48 (-47.83%)
Mutual labels:  doc, markdown
Gotenberg
A Docker-powered stateless API for PDF files.
Stars: ✭ 3,272 (+3456.52%)
Mutual labels:  api, markdown
Health Checks Api
Standardize the way services and applications expose their status in a distributed application
Stars: ✭ 78 (-15.22%)
Mutual labels:  api, apidoc
Swagger2markup
A Swagger to AsciiDoc or Markdown converter to simplify the generation of an up-to-date RESTful API documentation by combining documentation that’s been hand-written with auto-generated API documentation.
Stars: ✭ 2,330 (+2432.61%)
Mutual labels:  api, markdown
Docsify
🃏 A magical documentation site generator.
Stars: ✭ 19,310 (+20889.13%)
Mutual labels:  doc, markdown
Usaspending Api
Server application to serve U.S. federal spending data via a RESTful API
Stars: ✭ 166 (+80.43%)
Mutual labels:  api, markdown
Apidoc
RESTful API 文档生成工具,支持 Go、Java、Swift、JavaScript、Rust、PHP、Python、Typescript、Kotlin 和 Ruby 等大部分语言。
Stars: ✭ 785 (+753.26%)
Mutual labels:  api, apidoc
Mysql markdown
It can generate markdown structure documents of MySQL succinctly~
Stars: ✭ 227 (+146.74%)
Mutual labels:  doc, markdown
Parse Google Docs Json
Authenticates with Google API and parse Google Docs to JSON or Markdown
Stars: ✭ 100 (+8.7%)
Mutual labels:  api, markdown
Api Doc
📗基于Markdown编写的接口文档。
Stars: ✭ 47 (-48.91%)
Mutual labels:  api, markdown
Parvula
An extremely simple & flexible CMS generated from flat files with a complete RESTful API —
Stars: ✭ 76 (-17.39%)
Mutual labels:  api, markdown

Adoc

Just Another markdown doc editor

PHP 7.2 + Laravel 5.8 + React-Bootstrap

Features

  1. UI使用直角主题,以及不会腻的黑白色
  2. 编辑快捷键添加 ctrl/cmd + shift + s 保存并返回
  3. 添加了文档活动记录,暂无其他用途,只是个历史查看谁改动了哪些文档
  4. github 风格文档历史对比(react-diff-viewer)
  5. 添加文档附件功能
  6. 编辑、展示和导出都使用 editor.md,(showdoc编辑和展示是两个不同的程序)
  7. 文档菜单无限极分类(编辑父级同样)
  8. 文档菜单滑动到顶部固定
  9. 文档搜索
  10. 编辑器/显示 使用等宽字体,避免空格排版、数字/符号显示不明显问题
  11. JSON工具生成MD表格为字段增加了 padEnd 空格填充,使之尽量都在一列
  12. 文档左侧列表拖动排序(react-beautiful-dnd),湿滑纵享,强迫症福利
  13. 文档点赞,文档评论

💚github

github

安装

git clone https://github.com/yybawang/Adoc.git
cd Adoc
composer install
php artisan app:install

// 访问 APP_URL 测试

升级

  • 更新代码和数据库迁移
git pull
composer install
  • [x] 项目功能
    • [x] 项目新增
    • [x] 项目配置
    • [x] 项目权限分配,使用 gate
    • [x] 项目删除
    • [x] 项目所有权转移
    • [x] 项目置顶,列表排前显示,替代排序功能(只会影响当前用户,非全局排序)
    • [ ] 项目tag标签
    • [ ] 列表可选使用 tag 分组展示
  • [x] 文档功能
    • [x] 文档增删改查
    • [x] 文档自定义模版
    • [x] 文档修改历史,对比、还原
    • [x] 文档模版
    • [x] markdown 编辑器图片上传,上传到 laravel 配置的 filesystem 配置中,默认 public
    • [x] 文档编辑时可能已被修改过,提示先备份再编辑
    • [x] 文档搜索,头部右上角,暂只支持搜索当前展示项目下文档
    • [x] 文档列表拖动排序
    • [x] 文档附件
    • [x] JSON工具,json 转MD表格,json 美化
    • [x] 文档 github 风格选择 emoji 反应
    • [x] 文档评论,三天内可删除
    • [x] 新建文档如果未填写标题,默认为 Y-m-d,用于在线记事本使用
  • [x] 编辑器快捷键优化
    • [x] Ctrl/Cmd + s 保存(停留当前页), Ctrl/Cmd + Shift + s 保存并返回到列表
    • [x] Ctrl + d 插入当前时间
    • [x] Cmd + d 复制当前行到下一行

示例 示例 示例 示例 示例

Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].