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

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

前言

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


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

  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/

相关文章
|
数据采集 JSON JavaScript
Python爬虫案例:抓取猫眼电影排行榜
python爬取猫眼电影排行榜数据分析,实战。(正则表达式,xpath,beautifulsoup)【2月更文挑战第11天】
921 2
Python爬虫案例:抓取猫眼电影排行榜
|
SQL 分布式计算 大数据
大数据Spark框架概述
大数据Spark框架概述
1042 0
|
11月前
|
机器学习/深度学习 运维 算法
【两阶段鲁棒优化问题】用列和约束生成方法求解两阶段鲁棒优化问题(Matlab代码实现)
【两阶段鲁棒优化问题】用列和约束生成方法求解两阶段鲁棒优化问题(Matlab代码实现)
525 3
|
12月前
|
JSON 监控 数据挖掘
揭秘小红书电商 API,让小红书店铺品牌曝光量飙升
在社交电商时代,小红书已成为品牌营销的重要平台。本文介绍小红书电商API的基础概念与核心功能,通过自动化管理、内容发布与数据分析,帮助商家提升曝光与品牌影响力。结合实战示例,教你如何利用API实现数据驱动的营销策略,最大化曝光增长。
|
数据可视化 机器人 编译器
科力雷达Lidar使用指南
本文是科力2D激光雷达Lidar的使用指南,包括了雷达的安装、编译、IP配置、上位机软件使用、ROS节点运行、参数配置、官方文档和软件资源链接,以及雷达通讯建立失败等问题的解决方案。适用于Ubuntu20.04(x86) PC和Ubuntu20.04(Arm) Nvidia Orin环境。
1280 1
科力雷达Lidar使用指南
|
数据可视化 JavaScript API
鸿蒙低代码可视化ArkUI代码生成器
鸿蒙低代码可视化ArkUI代码生成器
706 0
|
自然语言处理 安全 API
「AIGC」LangChain
LangChain,Python开源NLP框架,助开发者轻松利用预训练模型进行文本生成、问答等任务。安装Python 3.6+后,用`pip install langchain`添加依赖。加载模型如GPT-3: ```python from langchain.llms import LLM model = LLM(model_name='gpt-3') ```
692 0
|
存储 前端开发 安全
无限连接:前端跨页面通信的实现与应用
在前端开发中,有时我们需要在不同的页面之间进行数据传递和交互。这种场景下,前端跨页面通信就显得尤为重要。前端跨页面通信是指在不同的页面之间传递数据、发送消息以及实现页面间的交互操作。本文将详细介绍前端跨页面通信的属性、应用场景以及实现方法,并提供一些代码示例和引用资料,帮助读者深入了解并应用这一重要的技术。
|
存储 算法 数据挖掘
R语言和Python用泊松过程扩展:霍克斯过程Hawkes Processes分析比特币交易数据订单到达自激过程时间序列
R语言和Python用泊松过程扩展:霍克斯过程Hawkes Processes分析比特币交易数据订单到达自激过程时间序列