首页
学习
活动
专区
工具
TVP
发布
精选内容/技术社群/优惠产品,尽在小程序
立即前往

实战 | docsify+云开发,高效创造你的文档网站

想要将docsify生成的文档网站发布出去,以前我们会选择GitHub Pages来进行网站托管。但由于GitHub是国外网站,会导致你的文档网站访问速度较慢。...云开发静态网站托管支持通过云开发SDK调用服务端资源如:云函数、云存储、云数据库等,从而将静态网站扩展为全栈网站。...下面,只需5分钟,利用docsify+云开发高效创造和部署你的个人文档网站吧! 系统依赖 在进行后续的内容前,请先确保你的电脑中安装了 Node.js 运行环境。...文档网站已经生成,但此时仅自己本地可见。如何让其他人看到自己的网站呢? 我们可以利用云开发的静态托管部署功能,只需几步,轻松发布自己的网站。...用静态托管部署你的文档网站 首先进入腾讯云的云开发(cloudbase)控制台: ? 点击立即创建,开通一个云环境: ?

1.2K40
您找到你想要的搜索结果了吗?
是的
没有找到

SpringBoot整合Docsify生成网站文档

关于Docsify 官网地址:https://docsify.js.org/ 在Docsify官网对Docsify是这样的描述的, docsify 是一个动态生成文档网站的工具。...),个人觉得没有必要去搭建一个项目去做这件事,就好像我写了一个 接口,我更加希望在该项目中直接写好文档,然后可以直接看。...编写templates目录下的doc.html,这里和文档介绍相似 <!...于是 每天学Java的网站也就出来了,网站将小程序的题库数据抽离出来,在加上新的模块:功能集锦,用 于将自己工作中使用的技术进行一次整理封装和优化。...到这里就完成SpringBoot结合Docsify生成文档,笔者觉得在一些小项目中,这样可以非常快速的 生成网站文档,不用另外新建项目。

1.6K40

Linux在线搭建自己的文档网站

1. teedoc 简介 一款用 Python 写的文档网站生成工具,支持从 Markdown 或者 jupyter notebook 转换成 HTML,支持多文档,多语言,支持自定义页面等功能 效果和文档...: github.com/teedoc/teedoc.github.io 将 Markdown 或者 Jupyter Notebook 格式的文档转换为 HTML 网页 像其他工具也有read the...docs, docusaurus,docsify,gitbook等等 teedoc使用了 Python 作为开发语言,足够简单易用,要做自定义也很简单, 前端也只用了一个jquery,没有其它复杂的框架...,相信很多开发者都有能力基于这个进行自定义开发,另外也支持插件哦~ 2....特性 使用简单, 跨平台,只依赖 Python3 部署简单, 生成的网站是全静态页面,直接拷贝到服务器或者上传到三方机构即可部署 书写简单,使用 Markdown 语法编写 Jupyter notebook

4.4K50

教你使用docsify生成美观的文档网站

docsify 是一个动态生成文档网站的工具,可以将.md 文件以 wiki 的形式展示给读者,可以用于制作技术文档、用户手册、wiki 等,快速以网站形式构建、发布软件的API手册或用户说明文档,方便用户使用你的软件...特性 没有静态构建的html文件 简单轻巧(约21kB gzipped) 智能全文搜索插件 多个主题 有用的插件API 表情符号支持 与IE11兼容 支持服务器端渲染 官方文档:传送门 快速开始 首先安装...npm 全局安装 docsify-cli ,这有助于在本地初始化和预览网站。.../docs 子目录中编写文档,可以使用 init 初始化 docsify init ./docs 在之后 init 完成后,你可以看到在文件列表./docs子目录。...index.html 作为条目文件 README.md 作为主页 .nojekyll 阻止GitHub页面忽略以下划线开头的文件 预览网站 使用运行本地服务器 docsify serve 。

1.1K10

VuePress搭建永久文档博客网站VuePress 使用

VuePress是尤大神发布的一个全新的基于vue的文档生成器 在线预览 地址 源码 地址 效果图预览 ↓ ↓ ↓ ? 文档首页 ?...详细文档 开发准备 一个github账号,没有的要自己注册一个 注册地址 会使用git工具,克隆及提交代码等简单操作,git学习请自行 百度 Markdown语法参考地址 Markdown 只需要满足上述三个要求...,任何人就都可以写出来一套属于自己的文档网站~ 新建github代码仓库 ?...- title: Vue驱动 details: 享受 Vue + webpack 的开发体验,在 Markdown 中使用 Vue 组件,同时可以使用 Vue 来开发自定义主题。...最后说下为什么用这种方式写一些文章、笔记 我曾在自己的服务器上写博客,笔记网站,优点就是什么都可以自定义,并且想改什么就改什么。

2.2K30

Chartist 图例开发入门-文档

(2) css直接引入 一种最快捷的方式就是直接引入下载的chartist编辑的js/css文件,它允许开发人员使用默认的命名方式或者可配置的方式来应用chartist到项目中,也可以通过修改chartist.../latest/chartist.min.js"> (3) sass 如果项目中要求的定制化要求较高,也可以直接引入sass源代码文件进行定制化开发...default; 2、第一个应用 这部分文档是一个简易的应用项目,让开发人员能快速掌握chartist的使用方式,入门项目中会通过默认的基础配置实现一个线性图形解构,如果你有更复杂的应用需求,可以参考一下高级应用部分或者查看示例文档...,如320x240和300x200两个不同的比例,对于设计人员可能思考的更多的是4:3或者3:2的比例关系,而对于开发人员思考的更多的是具体的像素数据 chartist中开发人员不需要设置固定的宽度或者高度...Chartist提供了一种事件驱动的动态图例方式,允许开发人员通过draw事件直接操作图例中的任意数据和样式,我们通过一个案例观察如何通过数据动态设置图例 <!

4K20

没有需求文档,拒绝开发

读者提问: 在我们公司,需求都是开发口头去问产品,就直接开发了。产品不给写需求文档开发和测试同学应该接受吗 ? 阿常回答: 不能接受。 1、没有需求文档,拒绝开发。 2、没有需求文档,拒绝测试。...为什么必须要沉淀文档? 1、没有需求文档开发口头问产品聊来的需求不准确,在此基础上开发的功能容易出现偏差。 2、没有需求文档,测试不知道有哪些测试点,同时极大地增加了产研测之间的沟通成本。...3、产品口头说的需求,过两天产品又需求变更了,产品自己忘记了原来的需求,开发很苦恼,测试也无奈。 沉淀文档有哪些形式呢? 1、confluence 上原始需求文档沉淀。...2、axure 交互设计稿文档沉淀。 3、jira 任务备注测试点(附confluence / axure 等链接)。...4、如果实在没时间整理需求文档,起码要在 jira 任务里写清楚测试要点、业务逻辑。 另外,如果有需求变更也应该及时同步。否则,也会极大增加沟通成本。 阿常碎碎念: 六一上海全面解封啦!

95210

SDK开发经验之文档

我们遇到的问题 我们的SDK做了这么久,被开发商嗤之以鼻最多的问题之一就是文档。主要表现在: 问题的原因比较多,主要是三个方面: 没有完整的线上文档,所有的接口文档都是跟随版本包。...由于以上的问题,经常出现: 游戏更新版本以后没有同步使用新版本的文档,无法同步更新我们已经修正的文档错误或者新增的版本内容 或者由于文档比对太过麻烦和版本太多,开发修改文档错误以后比较难同步修改到其余版本...因为这样开发商下载到一次以后就再也不会更新了…… 文档online化总要解决,不然上面的问题会一直存在。为了让伟大的开发哥哥们不受困于wiki,最后在github终于找到了神器。...使用Markdown可以大大提高开发者的开发效率。 分模块:如果你的SDK够大,建议最好是按照模块来写文档。...包括SDK包内容介绍、SDK的架构的简单介绍、开发者接入SDK、更新SDK的操作指引、打包的混淆规则等内容。 API文档:按照模块区分介绍对应模块API的使用方法。

1.6K80

bookStore商城开发文档

bookStore商城开发文档 一、项目演示 看课堂笔记。 二、需求分析   2.1、系统体系结构 基于BS结构进行开发。(浏览器与服务器:瘦客户端)   2.1、系统总体流程 ?   ...前端:前端开发人员做成静态网页。 后端:后端开发人员实现动态网页。    2.4.1、前台界面     商城首页 ?     注册页面 ?     登录页面 ?     图书浏览页面 ?     ...orders` (`id`), FOREIGN KEY (`product_id`) REFERENCES `products` (`id`) ) 四、系统设计   4.1、开发环境...    开发本系统我们所使用的工具与技术有: Myeclipse10 tomcat7.x mysql5.x   jst标签库  EL表达式  jsp  servlet  javabean...commons-dbutils commons-fileupload  commons-beanutils  c3p0  jdk1.6   jdbc   4.2、架构设计     采用javaweb开发的三层架构

2K10

文档代码化:重塑软件开发文档系统

文档代码化,将文档以类代码的领域特定语言的方式编写,并借鉴软件开发的方式(如源码管理、部署)进行管理。它可以借助于特定的工具进行编辑、预览、查看,又或者是通过专属的系统部署到服务器上。...面向非技术人员的文档代码化的一种常见架构模式是:编辑-发布-开发分离』。 最近一个月里,我在开发一个基于 Git + Markdown 的全新文档系统。...静态站点生成是一种混合式的 Web 开发方法,它通过部署预先构建的静态文件进行部署,来让开发者在本地构建基于服务器的网站。...如网站标准 HTML,又或者是 Docx、Latex 等 支持编辑、校对工作流 支持搜索 多人协作 而事实上,大部分的团队并不需要上述的高级功能,而且它们都已经有了成熟的方案。...发布这个项目 我们已经在 GitHub 上发布了这个文档化系统,你可以参与到其中的使用和开发

1.3K20

【玩转 Cloud Studio】搭建属于自己的文档网站

前言解释一下什么是Cloud Studio ,是一个基于浏览器的集成式开发环境(IDE),为开发者提供了一个永不间断的云端工作站。...一个神奇的文档网站生成器。docsify 可以快速帮你生成文档网站。不同于 GitBook、Hexo 的地方是它不会生成静态的 .html 文件,所有转换工作都是在运行时。...无需构建,写完文档直接发布容易使用并且轻量 (压缩后 ~21kB)智能的全文搜索提供多套主题丰富的 API支持 Emoji兼容 IE11支持服务端渲染 SSR 不多说开发演示吧1、搭建前准备打开Cloud...项目默认运行端口为 3000 docs为Docsify-Plus的默认目录,此目录可自行更改,可改为更目录docsify serve docs 下面就是成功运行了,点击内置预览图片出现右边预览区的图片 就是我们的文档网站搭建成功了...图片这里我们的文档网站就搭建成功了

1.1K172
领券