今天给各位分享多语言企业网站源码分享下载的知识,其中也会对多语言网站的实现进行解释,如果能碰巧解决你现在面临的问题,别忘了关注本站,现在开始吧!
一、开源项目简介
ShowDoc是一个非常适合IT团队的在线API文档、技术文档工具。通过showdoc,你可以方便地使用markdown语法来书写出美观的API文档、数据字典文档、技术文档、在线excel文档等等。如果不想编辑markdown文档,你还可以利用showdoc的自动化能力,从程序注释中自动生成API文档,或者从搭配的RunApi客户端(类似postman的api调试工具)中一边调试接口、一边自动生成文档。通过分配项目成员和团队成员,你可以很方便地进行项目文档的权限管理和团队协作,也可以分享文档出去给朋友查看。ShowDoc还支持多平台客户端,有win客户端、mac客户端、ios、android等,更方便跨平台使用。目前超过100000+的互联网团队正在使用showdoc,包括知名公司内部的一些团队,比如腾讯、华为、百度、京东、字节跳动等等。
二、开源协议
使用Apache-2.0开源协议
三、界面展示
四、功能概述
它可以用来做什么
API文档随着移动互联网的发展,BaaS(后端即服务)越来越流行。服务端提供API,APP端或者网页前端便可方便调用数据。用ShowDoc可以非常方便快速地编写出美观的API文档。数据字典一份好的数据字典可以很方便地向别人说明你的数据库结构,如各个字段的释义等。说明文档你完全可以使用showdoc来编写一些工具的说明书,也可以编写一些技术规范说明文档以供团队查阅
它都有些什么功能
分享与导出响应式网页设计,可将项目文档分享到电脑或移动设备查看。同时也可以将项目导出成word文件,以便离线浏览。权限管理公开项目与私密项目ShowDoc上的项目有公开项目和私密项目两种。公开项目可供任何登录与非登录的用户访问,而私密项目则需要输入密码验证访问。密码由项目创建者设置。项目转让项目创建者可以自由地把项目转让给网站的其他用户。项目成员你可以很方便地为ShowDoc的项目添加、删除项目成员。项目成员可以对项目进行编辑,但不可转让或删除项目(只有项目创建者才有权限)团队管理利用showdoc的团队功能你可以更好地进行团队协作编辑功能markdown编辑ShowDoc采用markdown编辑器,无论是编辑还是阅读体验都极佳很棒。如果你不了解Markdown,请在搜索引擎搜索”认识与入门Markdown”模板插入在ShowDoc的编辑页面,点击编辑器上方的按钮可方便地插入API接口模板和数据字典模板。插入模板后,剩下的就是改动数据了,省去了很多编辑的力气。历史版本ShowDoc为页面提供历史版本功能,你可以方便地把页面恢复到之前的版本。多平台showdoc支持网页版、手机app版和电脑客户端版。自动化可从代码注释中自动生成文档搭配的RunApi客户端,可调试接口和自动生成文档
五、技术选型
技术栈说明
前端:Vue+ElementUI
后端:为了兼容低版本的php运行环境(兼容至5.3),使用的是保守的ThinkPHP3.2.3框架
数据库:showdoc自带文件型数据库(/Sqlite/showdoc.db.php),不需要用户手动安装数据库
开发前准备
开发机器需要先安装好PHP环境和NodeJS环境
下载代码并放置到PHP环境下的www目录
先在浏览器通过地址访问,以便完成showdoc的初始化安装(如已安装过则忽略)
在命令行里进入showdoc的web_src目录,执行npminstall以安装依赖。(若无npm,你则先要安装NodeJS环境)
前端开发
执行npmrundev以启用调式模式,通过访问localhost:8080便可以实时看到改动的效果。请使用代理以便请求后端API的时候代理到PHP服务端。设置代理可以用自己顺手的代理工具,或者参考这里
需要执行npmrunbuild才会最终打包生效。打包后的静态文件会在/web目录下
主要涉及到的目录和文件:
web_src/src/router页面组件基本都放在这里web_src/static前端语言包
后端开发
主要涉及到的目录和文件
server/Application/Api/如果有错误日志,会直接打印出浏览器或者打印到这里Public/Uploads后端语言包
其它说明
二次开发后请尊重开源项目,保留版权标识和链接
如开发了好用的功能,不妨贡献到官方github代码仓库以分享给大家用
showdoc往后升级可能会覆盖你原有的二次开发。如果想兼容,最好提交到官方仓库成为官方功能。
关注公众号,发送如下消息获取下载链接:
&34;
多语言企业网站源码分享下载和多语言网站的实现的问题分享结束啦,以上的文章解决了您的问题吗?欢迎您下次再来哦!
