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

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

前言

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


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

  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/

相关文章
|
3月前
|
存储 定位技术 Swift
探索iOS开发:从新手到专家
【8月更文挑战第29天】在这篇指南中,我们将一起踏上iOS开发的旅程。无论你是刚入门的新手,还是希望提升技能的开发者,本文将为你提供一条清晰的道路。我们将从基础概念讲起,逐步深入到高级技巧,确保你能够掌握iOS开发的核心知识。准备好了吗?让我们开始吧!
|
2月前
|
存储 XML API
安卓应用程序开发:从新手到专家的旅程
【8月更文挑战第33天】在这篇文章中,我们将一起踏上一段激动人心的旅程,探索如何从一个对安卓应用程序开发一无所知的新手,成长为一个能够独立开发复杂应用程序的专家。我们将通过实际案例和代码示例,深入理解安卓开发的各个方面,包括用户界面设计、数据存储、网络通信等。无论你是刚刚入门,还是已经有一些基础,这篇文章都将为你提供宝贵的知识和技能,帮助你在安卓开发的道路上更进一步。
|
4月前
|
机器学习/深度学习 Kubernetes 云计算
阿里云的「技术文档工程师」和「技术翻译」
- 阿里云智能集团招聘技术岗,位于杭州和北京。 - 技术文档工程师岗位要求包括独立编写代码能力、快速学习新技术、简化复杂技术概念、扎实的技术理解和良好的时间管理。 - 翻译工程师还需具备相关学历背景、技术翻译经验和云产品知识。 **团队成员分享:** - 昱心(南洋理工大学,机器学习)和骞腾(UIUC,计算机科学)分享了他们在技术文档岗位上的成长,涉及大模型和K8S等技术。 - 舟预(北京交通大学,信息管理)强调技术文档的重要性,认为它是阿里云对外的权威发言人。 - 天蒙(南开大学,信息与通信工程)提到工作中与代码的紧密联系,团队支持技术成长。
23826 24
阿里云的「技术文档工程师」和「技术翻译」
|
3月前
|
设计模式 开发工具 Swift
探索iOS开发:从新手到专家的旅程
在这篇指南中,我们将踏上一段激动人心的旅程,从iOS开发的基础知识开始,逐步深入到高级技巧和最佳实践。无论你是编程新手还是有经验的开发者,本篇文章都将为你提供宝贵的资源和启示,帮助你在不断变化的移动应用世界中找到自己的位置。就像甘地所说:“你必须成为你希望在世界上看到的改变。” 让我们一起成为那个改变,掌握iOS开发的艺术。
79 0
|
5月前
|
小程序 前端开发 JavaScript
微信小程序|大学生心理健康测评管理系统的设计与实现
微信小程序|大学生心理健康测评管理系统的设计与实现
微信小程序|大学生心理健康测评管理系统的设计与实现
|
5月前
|
设计模式 存储 Swift
探索iOS应用开发:从新手到专家
【6月更文挑战第28天】在这篇文章中,我们将深入探讨iOS应用开发的各个方面。无论你是刚开始学习iOS开发的新手,还是已经有一定经验的开发者,这篇文章都将为你提供有价值的信息和指导。我们将从基础知识开始,逐步深入到更复杂的主题,包括设计模式、性能优化和最新的iOS技术趋势。通过这篇文章,你将获得从新手到专家的全面指导。
|
5月前
|
存储 ice 索引
经验大分享:PJSUA2开发文档
经验大分享:PJSUA2开发文档
73 0
|
5月前
|
存储 JSON 数据格式
项目实践《招聘网站数据》
项目实践《招聘网站数据》
|
6月前
|
Java API 开发工具
安卓应用程序开发:从新手到专家
【2月更文挑战第28天】 在这篇文章中,我们将探索安卓应用程序开发的过程,从基本概念到高级技术。我们将讨论如何设置开发环境,创建你的第一个安卓应用,理解安卓的生命周期,以及如何使用各种API和库来增强你的应用。无论你是刚刚入门的新手,还是希望提升技能的开发者,这篇文章都将为你提供有价值的信息。
|
移动开发 小程序 安全
对比多个笔记软件后,我选择了语雀
去年开始带团队,在面临团队文档管理共享软件选择时,我毫不犹豫的选择了语雀,语雀的协作功能非常出色。可以邀请团队成员加入我的笔记工作空间,共同协作编辑和维护笔记和文档。通过语雀,可以很方便地进行团队内部的协作和交流,并对笔记进行版本控制,以避免多人编辑时出现不同步的问题。通过团队空间、知识库、目录的层级管理,能很好的将知识做分类。
430 0
下一篇
无影云桌面