使用 CSS 提升你的 HTML 文档 (linux.cn)

【简介】

当你编写文档时,无论是为开源项目还是技术写作项目,你都应该有两个目标:文档应该写得好,同时要易于阅读。前者通过清晰的写作技巧和技术编辑来解决。第二个目标可以通过对 HTML 文档进行一些简单的更改来解决。
超文本标记语言(HTML)是互联网的支柱。自 1994 年“万维网”问世以来,所有网络浏览器都使用 HTML 来显示文档和网站。几乎与此同时,HTML 一直支持样式表,它是对 HTML 文档的一种特殊添加,用于定义文本在屏幕上的呈现方式。
单纯用 HTML 编写项目文档也是可以的。然而,纯 HTML 样式可能感觉有点简陋。因此,尝试向 HTML 文档添加一些简单的样式,为文档添加一点活力,并使文档更清晰、更易于阅读。

点击查看原文 >>

@技术头条 2023-04-16 21:10 / 原作者微博:@Linux中国 / 0个评论
赞过的人: @IT技术博客大学习
要不要再学学下面的文章?
如何编写技术文档? (insights.thoughtworks.cn)
所谓编写技术文档,基本意味着以结构化的方式组织文档,传达出清晰明确的信息,来让用户正确的使用你的软件产品。结构化文档不仅仅是当前最为主流的文档组织方式,在可预见的未来也会如此。
by @Thoughtworks 2023-08-16 14:07 查看详情
智能文档处理IDP关键技术与实践-高翔 (www.52nlp.cn)
什么是智能文档处理?针对文本数据处理尤其是纯文本,大家通常会想到使用自然语言处理(Natural language processing,NLP)技术来解决语义理解及分析处理工作。关于自然语言处理技术的研究有很长历史,针对不同层面文本处理和分析有很多技术点,常见技术例如分词与词性标注、命名实体识别、句法结构分析、文本分类、文本摘要等功能。
by @技术头条 2022-12-10 22:41 查看详情
一键部署!搭建一个文档网站超简单! (mp.weixin.qq.com)
最近笔者在复习 JavaScript 基础知识,刚看完 《JavaScript 高级程序设计(第四版)》,想再找一些优秀代码库巩固一下学到的内容,自然而然的就想到了Lodash。
by @code小生 2021-12-26 12:21 查看详情
浅谈协同文档中的数据一致性 (www.alloyteam.com)
在线文档是一个数据一致性要求很强的项目,我们经常会提到一个在线文档的技术:“协同冲突处理算法——OT”。这是协同编辑处理的核心。因为它保障了在多客户端同时提交修改的情况下的数据一致性,用通俗一点的方式描述:多人在线编辑,每个人提交的内容不一样,但通过协同冲突算法,最终都能看到一样的内容。

但在这里我们不想深入去探讨协同编辑冲突算法的具体内容,对这块有兴趣的朋友可以参考之前我们团队的博客,已经有过很多介绍。本文主要是介绍协同冲突算法产生的原因,以及它背后关于数据一致性的问题。
by @技术头条 2021-05-27 08:13 查看详情
这份《REAME 书写指南》送给不写文档的程序员 (mp.weixin.qq.com)
如果你很着急、只是想要模板,可以直接跳到底部(但这样一点不酷),准备酷的人,迈出成为README大师的第一步吧!(绝对不是点击诱饵)
by @code小生 2021-01-26 00:46 查看详情
Pandas官方文档中文版下载、图形深度学习 PPT 下载 (mp.weixin.qq.com)
Pandas是一个强大的分析结构化数据的工具集;它的使用基础是Numpy(提供高性能的矩阵运算);用于数据挖掘和数据分析,同时也提供数据清洗功能。
by @code小生 2020-06-21 22:35 查看详情
使用 YApi 管理 API 文档,测试, mock (juejin.im)
接口的维护管理非常耗时,大概占用了30%开发时间。后端程序员要维护对于他们冗余的文档,前端程序员又因为后端开发提供的文档不准确,导致浪费了大量的时间。
接口的正确性和稳定性很难保证,前端工程师为了处理各种数据异常情况,将会写大量异常处理逻辑。传统的接口自动化测试成本非常高,开发一个接口可能只需要一天,但写接口测试用例,需要花费好几天的时间。

对于前端程序员,在后端功能没有开发完成之前,他们需要接口返回数据 Mock ,以便不影响开发进度。传统的数据 mock 是把模拟数据写到项目代码里,这么做会带来更多新的问题,首先后端程序员定义的接口随着需求、架构涉及随时发生变化的,如果前端程序员完全按照最初的设计定义mock数据,将会和实际做出来的接口有很大的出入。

没有一个标准化的流程统一处理,这个过程是非常分散的,需要配合非常多的工具,效率比较低。
by @shengting 2020-04-20 14:53 查看详情
Android 10文档阅读总结 (mp.weixin.qq.com)
有好长一段时间没写文章了,自从栽了一颗之后就开始疯狂的吸取养分。其实前段时间不写文章主要是:发现要学的东西太多,总觉时间不够。而且写文章要比学习某个内容要花费更多的时间。结果最近发现有点消化不良。今天就抽空给做个总结。先给大家展示一下<分支>,大家就知道这篇文章要写咋了。
by @code小生 2019-11-11 09:48 查看详情
细说API – 文档和前后端协作 (insights.thoughtworks.cn)
在上一篇文章——《细说API – 重新认识RESTful》中介绍了如何理解和设计RESTful风格的API,现在我们来聊聊如何有效的呈现API文档,以及前后端协作的方式。
by @Thoughtworks 2019-02-22 15:20 查看详情
智能媒体管理产品文档转换/预览功能介绍(4)--快速搭建 (yq.aliyun.com)
智能媒体管理提供了 Cloud Native 架构的文档转换/预览服务,本文介绍快速搭建的示例,让您用 DIY 的体验方式实现文档预览功能。
by @幸运的猫耳 2018-05-16 22:54 查看详情