编写文档说明 学 python 的人一定会注意到很多python 文档都很相似,不管是整体风格还是结构组织方式都很类似。 比如: scrapy 文档 scrapy.png 再比如: flask 文
本文从 “是什么”、“为什么”、“怎么办”、“好不好” 四个维度来介绍 GitBook,带你从黑暗之中走出来,get 这种美妙的写作方式。
喜欢用 Markdown 写文档,那怎么把一个个 Markdown 文档组成在一起呢?
GitHub是一个软件源代码托管服务平台,用大白话说就是一个专门用于存放文件的“网盘”,只不过这个“网盘”是专门为开发者做的,帮助开发者存储和管理代码。目前这个平台汇集了超过5千万开发者。
简书对markdown的支持非常好,而github恰好也是非常鼓励使用markdown格式,这次我们尝试将简书的文章,搬到GitHub平台. 我以前在简书发布过的一篇"图虫遇爬虫",这篇文章有代码,
GitBook是使用Git管理书籍项目,使用Markdown撰写书籍,并使用GitHub和GitBook网站进行托管的一个实用工具。下面简单说一下新手如何使用该强大的工具。
技术文档是程序员必备的参考书。那么如何高效地编写简洁优雅的技术文档,并快速发布到互联网上供他人阅览呢?
我们在 码云 上创建新项目的时候,常常会看到默认使用 README 文件初始化该项目(如图1 所示),然后在新建项目的根目录下就会生成一个 README.md 文件(如图2 所示)。 图1 默认选中
最近一直在想如何利用 COS 简化静态博客的搭建过程。搜了很多的静态博客搭建过程,发现大部分的静态博客都要通过编译才能生成静态页面。功夫不负有心人,终于让我找到了一个超简洁博客的搭建方法。
之前尝试过搭建自己的博客,有知名的 PHP 动态博客 WordPress 托管到我自己的服务器上,后面又自己开发了一款 SpringBoot 和 VUE 的前后端分离博客,这个用来学习还是不错的,但是终归需要一个服务器来跑这个,而且需要数据库 MySQL 之类的 关系型数据库 用来存储数据,用有逼格的专业话讲就是 用关系型数据库将数据持久化。
这个安装很简单,只需要下载,然后一路 next 即可。下载链接:https://nodejs.org/en/
VuePress V2 是一个以 Markdown 为中心的静态网站生成器。你可以使用 Markdown在新窗口打开 来书写内容(如文档、博客等),然后 VuePress 会帮助你生成一个静态网站来展示它们。
GitBook是一个基于 Node.js 的命令行工具,可使用 Github/Git 和 Markdown 来制作精美的电子书
保存并提交代码至github,提交代码后等待1分钟 浏览器访问 http://自己的github用户名.github.io 看到hello github 到这一步 Github Page已经可以正常使用 如果不想用VuePress写文档,可以随便写点东西提交代码即可更新。
Docsify 是一个动态生成文档网站的工具。不同于 GitBook、Hexo 的地方是它不会生成将 .md 转成 .html 文件,所有转换工作都是在运行时进行。
在已有内容的目录下,使用如下命令可以得到一个页面,浏览器访问 http://localhost:4000 即可看到。
GitBook 是一个基于 Node.js 的命令行工具,下载安装 Node.js(我以前搭建 hexo 的文章里也有介绍),安装完成之后,你可以使用下面的命令来检验是否安装成功。
之前的文章又发现几个有意思的网站 留言区有人问能不能整理个我推荐过网站的入口,于是我搭建了个博客将之前分享的上百个网站整理起来。
leetcode-notebook[1] 的题解越来越多,原先选择 Gitbook[2] 构建解题本的弊端逐渐显现出来,每次补充一道题解重新 build 项目时居然要花上 30 秒左右……
多级目录构建navbar、sidebar引用404问题:在构建多级文件目录的时候,针对多级文件夹下的md文件,其会相应加载同级目录下的navbar.md、sidebar.md文件,但这个时候由于navbar.md、sidebar.md文件存放在根目录或者是自定义指定的文件夹下,引用相对路径则会报404问题。针对上述情况,可以有如下调整方案:
其实这一需求已经被众多开发者"吐槽"了8年,GitHub可谓反应"迅速",于8年后的2022年5月19日宣布正式支持在 Markdown 中支持 LaTeX 格式的数学公式(大家再也不用贴图片了)。开发者可以通过在正文中添加的
你是否经常遇到这种情况:辛苦调好格式写好的 word 文档到其他人电脑上格式就莫名其妙的乱了;word 和 wps 处理的 docx 文档,不同的软件之间打开就是会出现一些很细微的差异。不得不说,就连微软自己将 office 系列软件的定位就是指一款 文字处理软件,在这样的软件之上可以完成几乎所有的格式调整工作,但并不保证不同的设备、软件之间可以互相通用;此外如果是记录笔记或是进行文字创作,等格式调整完毕或许创作热情早就燃烧殆尽,word 在此时就不是一个很好的选择了。
近期使用Typora编写文档的时候,写一些篇章比较短的文章还好。但是当篇章过长,标题目录过多的时候,那样就会导致阅读效果很差。
本文主要讲解第一种 gitbook-cli 命令行操作流程,其他两种见另外两篇教程.
新建一个名为你的用户名.github.io的仓库,这里,我的github用户名是Wasabi1234,那么就新建Wasabi1234.github.io的仓库,必须是你的用户名,其它名称无效,将来你的网站访问地址就是 http://Wasabi1234.github.io
通过 node -v 命令查看本机是否安装,如果没有安装,参考node.js安装指南 根据电脑系统环境进行安装
李俊负责 Cloud Studio 的产品规划,对于各种设计、开发工具有比较深的研究,一直在探索如何缩减设计开发之间的协作阻力。
Github Profile 用于展示个人的一些成果,把 Markdown 转换为 HTML 渲染在个人主页上,并且高度支持自定义。
今天我们继续介绍一款文档软件,它堪称程序员文档利器。是Docute的大哥。也是专注纯净的文档构建。对于SEO并不擅长,但是它简单高效的特点斩获了大批的用户,我也是其忠实的拥护者。
本文就来介绍一下 Docsify[1] + Github Page 的方式,旨在快速搭建属于自己的文档网站
众所周知 Mrakdown 是一个轻量级写作工具,由于工作和学习缘故基本上每天都会使用 Mrakdown,现在已经成为我离不开的主力写作工具,因为网上关于 Markdown 的资料大多比较零散,缺少系统和关联性,所以花了一点时间把我目前掌握的 Markdown 知识系统性的归纳总结一下,分享的同时也是为了方便自己以后查询方便。
Pycharm 分为 Community (社区版) 和 Professional(专业版),两个版本对比如下:
请注意,本文编写于 179 天前,最后修改于 161 天前,其中某些信息可能已经过时。
转载请标明出处: https://www.jianshu.com/p/307684deff51
VuePress 是静态站点生成框架之一,界面简介优雅,本文记录使用方法。 简介 VuePress 是尤雨溪(vue.js 框架作者)发布的一个全新的基于 vue 的静态网站生成器,实际上就是一个 vue 的 spa 应用,内置 webpack,可以用来写文档。 VuePress 有很多优点: 界面简洁优雅,不同于 Hexo,个人觉得更适合作为说明文档页 容易上手(半小时能搭好整个项目) 更好的兼容、扩展 Markdown 语法 响应式布局,PC端、手机端 Google Analytics 集成 支持
前段时间, 写了一篇从Github下载开源电子书, 收到很多赞, 有朋友问我, 如何写自己的开源电子书? 我在这里就详细的写一写... 前期准备: 申请一个自己的github账户 了解Markdown
markdown是一种文本标记语法,可以用几个符号解决繁琐的排版问题。非常适合写代码的文档、个人学习笔记等。
大家在Github上看项目的时候,是不是经常在项目介绍README.md里看到这种高大上的标签,以下截取自开源库OkGo的README.md。
摘要 在我之前的文章中,我使用了不同编程语言开发了如下许多上位机。 序号内容语言1《如何定制自己的HID调试助手》C#2《C# 串口上位机开发》C#3《Qt 串口上位机开发》QT4《教你动手写UDP协议栈 - OTA上位机》python5《基于RT-THREAD nano的平衡车--上位机软件》QT6《R-Plan上位机》QT7《BearPi TCP》QT 你会发现很零散,集成度,而且久而久之就没有维护了。今天我又来解锁一种开发工具的神器--VScode插件。 其实vscode现在已经很多大厂先后开发出他们
人们在网上首先发现你的地方是哪里?也许你的社交媒体是人们搜索你时首先发现的东西,亦也许是你为自己创建的投资组合网站。然而,如果你使用GitHub来分享你的代码并参与开源项目,那么你的GitHub个人主页可能是人们为了了解你而去的第一个地方。
You found a secret! zhangkn/zhangkn is a ✨special ✨ repository that you can use to add a README.md to your GitHub profile. Make sure it’s public and initialize it with a README to get started.
GitBook 是一个使用 Git 和 Markdown 来构建书籍的工具。它可以把你的书本生成为许多格式:PDF,ePub,mobi,或者成为一个网站。
相信很多童靴在敲代码之余,都致力于美化自身所处的环境。比如对博客网站的魔改,对IDE的美化,对电脑壁纸的精挑细选等等。
随着云原生应用的普及,Helm 的作用也日益凸显,越来越多的云原生应用以 Helm Chart 的形式发布,可以说现在如果没有一个 Helm Chart 都不好意思说自己是云原生应用。
要让你的网站显示内容, 就需要进行配置, 需要在.vuepress文件夹下新建一个总的配置文件config.js, 这个文件的名字是固定的,即.vuepress/config.js,它导出一个 JavaScript 对象,使用的是Commonjs文件导入导出的规范 如有对 CommonJS 使用疑惑可参考文档:commonJs 使用规范
截止至 2019 年 9 月,在 PYPL 编程语言榜单上,Python 因近几年受欢迎程不断提高而继续霸榜。微软开源的 VS Code 编辑器对 Python 支持力度越来越好,近期也推出了 Python 插件,支持了 Jupyter Notebook。
截止至 2019 年 9 月,在 PYPL 编程语言榜单上,Python 因近几年受欢迎程度不断提高而继续霸榜。微软开源的 VS Code 编辑器对 Python 支持力度越来越好,近期也推出了 Python 插件,支持了 Jupyter Notebook。
• 预览查看图片分辨率&大小 • 代码语法高亮 • 快速预览zip压缩包内容 • 快速预览markdown格式内容
领取专属 10元无门槛券
手把手带您无忧上云