让技术文档网站看起来更专业

简介: 让技术文档网站看起来更专业

前言

通常作为一名程序猿,涉猎的开发技术框架,开发工具。随着工作的深入会越来越多,越来越广。”好用的“文档网站,有助于浏览者,更加容易获取想要的信息或则解决方案,学习体验等。


一、技术文档网站该有的哪些方面?

  1. 简约合理的布局与整体网站配色
  2. 层级分明的菜单
  3. 明确的使用指南 🧭
  4. 有通用性,代表性强的示例代码/案例 💻
  5. 技术使用的注意事项 Q&A
  6. 支持多语言 🇨🇳
  7. 有对应的扩展资源链接🔗
  8. 技术适用的范围

二、举例

作为一个以vue为主要技术栈的前端仔,经常查阅的就是vue官网。

简约大气的布局👇

image.png

有比较系统性的入门教程 👇

image.png

最喜欢的部分就是这里,常见的案例,还可以实时编程,即刻体验。😊
image.png
)

三、 思考🤔

想拥有一个一样的博客网站。要怎么弄呢。vuepress 好像可以帮助我们实现。
https://www.vuepress.cn/

总结

以上就是今天要讲的内容,本文仅仅谈谈个人对“好用的”文档网站的看法

链接 https://vuejs.org/

相关文章
|
搜索推荐 数据可视化 数据安全/隐私保护
免费、强大的开源笔记软件Joplin综合评测 —印象笔记的开源替代
Joplin 介绍 绝大部分开源工具都是免费的。如果寻找免费的笔记应用,自然需要考虑开源笔记软件。 在我的视野范围内,常见开源笔记软件包括Boostnote、GitNote、Joplin. 其中,前两者都是面向开发人员,全平台、支持中文、支持浏览器插件和扩展。而 Joplin 则面向一般用户。下面主要介绍 Joplin.
1878 0
免费、强大的开源笔记软件Joplin综合评测 —印象笔记的开源替代
|
2月前
|
存储 XML API
安卓应用程序开发:从新手到专家的旅程
【8月更文挑战第33天】在这篇文章中,我们将一起踏上一段激动人心的旅程,探索如何从一个对安卓应用程序开发一无所知的新手,成长为一个能够独立开发复杂应用程序的专家。我们将通过实际案例和代码示例,深入理解安卓开发的各个方面,包括用户界面设计、数据存储、网络通信等。无论你是刚刚入门,还是已经有一些基础,这篇文章都将为你提供宝贵的知识和技能,帮助你在安卓开发的道路上更进一步。
|
4月前
|
机器学习/深度学习 Kubernetes 云计算
技术文档工程师和技术翻译
- 阿里云智能集团招聘技术岗,位于杭州和北京。 - 技术文档工程师岗位要求包括独立编写代码能力、快速学习新技术、简化复杂技术概念、扎实的技术理解和良好的时间管理。 - 翻译工程师还需具备相关学历背景、技术翻译经验和云产品知识。 **团队成员分享:** - 昱心(南洋理工大学,机器学习)和骞腾(UIUC,计算机科学)分享了他们在技术文档岗位上的成长,涉及大模型和K8S等技术。 - 舟预(北京交通大学,信息管理)强调技术文档的重要性,认为它是阿里云对外的权威发言人。 - 天蒙(南开大学,信息与通信工程)提到工作中与代码的紧密联系,团队支持技术成长。
23837 24
技术文档工程师和技术翻译
|
5月前
|
小程序 前端开发 JavaScript
微信小程序|大学生心理健康测评管理系统的设计与实现
微信小程序|大学生心理健康测评管理系统的设计与实现
微信小程序|大学生心理健康测评管理系统的设计与实现
|
5月前
|
设计模式 存储 Swift
探索iOS应用开发:从新手到专家
【6月更文挑战第28天】在这篇文章中,我们将深入探讨iOS应用开发的各个方面。无论你是刚开始学习iOS开发的新手,还是已经有一定经验的开发者,这篇文章都将为你提供有价值的信息和指导。我们将从基础知识开始,逐步深入到更复杂的主题,包括设计模式、性能优化和最新的iOS技术趋势。通过这篇文章,你将获得从新手到专家的全面指导。
|
6月前
|
Java API 开发工具
安卓应用程序开发:从新手到专家
【2月更文挑战第28天】 在这篇文章中,我们将探索安卓应用程序开发的过程,从基本概念到高级技术。我们将讨论如何设置开发环境,创建你的第一个安卓应用,理解安卓的生命周期,以及如何使用各种API和库来增强你的应用。无论你是刚刚入门的新手,还是希望提升技能的开发者,这篇文章都将为你提供有价值的信息。
|
搜索推荐 前端开发 程序员
新手工程师需要知道的 7 件事
今年已经是我从事软件开发行业的第七个年头,我觉得现在是一个好的时机向一些新入行的软件工程师分享一些我认为越早知道越好的知识。希望能对您有所启发。 ## 1. 需求总是会变 也许您已经和团队成员评估了需求的合理性,并且达成了共识。您胸有成竹的认为产品需求不会再发生改变。但真相是残酷的,需求总是会因为各种各样的原因发生变化,例如: - 您或您的上司有了一个新的想法; - 产品的目标群体发生了变化
13261 1
|
计算机视觉
R沟通|Rmarkdown构建简历并部署到个人网站
上一期已经对使用 latex 模板构建 cv 做了较为详细的说明:R沟通|使用latex模板构建个人履历。但是存在一个问题:Latex 最后输出的是 pdf 版本,如果你想把他部署到自己的个人网站上,可能就比较费劲了(害,是我不会)。所以请教了李康国学弟之后,我又尝试了下使用 Rmarkdown 构建 cv 并将其部署到 gitee中,这样所有人都可以通过网址访问我的 cv 了。
324 0
R沟通|Rmarkdown构建简历并部署到个人网站
|
人工智能 小程序 数据安全/隐私保护
分享几个免费设计生成工具 (第二期)
今天来给大家分享几个国外免费的设计生成工具
109 0
|
搜索推荐 数据管理 大数据
专业测评:5款热门的免费报表软件
专业测评:5款热门的免费报表软件
专业测评:5款热门的免费报表软件