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

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

前言

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


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

  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/

相关文章
|
7月前
|
机器学习/深度学习 运维 算法
【两阶段鲁棒优化问题】用列和约束生成方法求解两阶段鲁棒优化问题(Matlab代码实现)
【两阶段鲁棒优化问题】用列和约束生成方法求解两阶段鲁棒优化问题(Matlab代码实现)
357 3
|
8月前
|
JSON 监控 数据挖掘
揭秘小红书电商 API,让小红书店铺品牌曝光量飙升
在社交电商时代,小红书已成为品牌营销的重要平台。本文介绍小红书电商API的基础概念与核心功能,通过自动化管理、内容发布与数据分析,帮助商家提升曝光与品牌影响力。结合实战示例,教你如何利用API实现数据驱动的营销策略,最大化曝光增长。
287 0
|
安全 Java API
ArrayList 全面详解
关注【mikechen的互联网架构】,10年+BAT架构经验倾囊相授。本文详细解析了Java集合框架中的ArrayList,包括其定义、特点、成员变量、构造函数、API、主要方法和扩容机制等。欢迎留言交流。
|
数据可视化 机器人 编译器
科力雷达Lidar使用指南
本文是科力2D激光雷达Lidar的使用指南,包括了雷达的安装、编译、IP配置、上位机软件使用、ROS节点运行、参数配置、官方文档和软件资源链接,以及雷达通讯建立失败等问题的解决方案。适用于Ubuntu20.04(x86) PC和Ubuntu20.04(Arm) Nvidia Orin环境。
987 1
科力雷达Lidar使用指南
|
缓存 负载均衡 应用服务中间件
Nginx入门 -- 理解Nginx基础概念:连接(Connection)
Nginx入门 -- 理解Nginx基础概念:连接(Connection)
473 4
|
数据采集 数据可视化 数据挖掘
R语言在金融数据分析中的深度应用:探索数据背后的市场智慧
【9月更文挑战第1天】R语言在金融数据分析中展现出了强大的功能和广泛的应用前景。通过丰富的数据处理函数、强大的统计分析功能和优秀的可视化效果,R语言能够帮助金融机构深入挖掘数据价值,洞察市场动态。未来,随着金融数据的不断积累和技术的不断进步,R语言在金融数据分析中的应用将更加广泛和深入。
|
消息中间件 并行计算 Java
Python中的并发编程
本文介绍了Python中的并发编程,并具体介绍了线程、进程、协程的基本用法和案例。
421 2
Python中的并发编程
|
并行计算 Ubuntu
ubuntu彻底卸载Nvidia显卡驱动
ubuntu彻底卸载Nvidia显卡驱动
3620 4
|
机器学习/深度学习 算法 前端开发
集成学习(Ensemble Learning)是一种机器学习技术,它通过将多个学习器(或称为“基学习器”、“弱学习器”)的预测结果结合起来,以提高整体预测性能。
集成学习(Ensemble Learning)是一种机器学习技术,它通过将多个学习器(或称为“基学习器”、“弱学习器”)的预测结果结合起来,以提高整体预测性能。
|
安全 Linux
top 命令可以使用的参数都有什么
【4月更文挑战第21天】top 命令可以使用的参数都有什么
781 1