Neoverse-Docs

0.2 使用本站

使用导航、搜索、代码块、任务进度与 Mermaid 等阅读功能

主要编写者:
本章 AI 摘要

本页介绍普通读者最常用的站点功能:导航与目录、全文搜索、主题、动效与语言、代码块、提示与折叠内容、任务进度、Mermaid 图表、页面操作和评论。页面最后有一组操作清单,可以边读边尝试

一、导航与页面结构

在宽屏设备上,文档页面通常分为三部分:章节导航、正文和本页目录。屏幕空间不足时,导航与目录会收起到对应的菜单中,正文仍然是阅读重点。

  • 章节导航:查看 Chapter、Stage 和页面顺序,在不同内容之间切换。
  • 正文:承载当前文档、示例和可交互任务。
  • 本页目录:根据标题快速跳转到当前页面的小节,并随阅读位置更新。

页面底部提供上一篇与下一篇入口,适合顺序学习。从正文链接跳到另一篇文档后,本站还会提供返回来源阅读位置的入口;不需要时可以将其关闭。

二、搜索

打开侧栏中的搜索入口,或按 Ctrl + K(macOS 为 Cmd + K)呼出全文搜索。

在文章正文中选中一段文字后,通过快捷键呼出搜索,会自动填入整理后的选区内容,最多取前 200 个字符;点击侧栏搜索入口不会读取正文选区。

  • 输入概念、命令、工具名或报错中的关键短语,不必先知道它位于哪个章节。
  • 中文页面标题与小节标题支持无声调全拼和拼音首字母,可以输入目标标题的连续全拼、以空格分隔的拼音或首字母;原文命中会优先显示。
  • 搜索范围可以设为全部内容,也可以限定到某个 Chapter。
  • 页面标题直接命中的文档组优先显示,其次是小节标题命中,最后是仅正文命中;每组内部按“文章标题、小节标题、正文命中”排列。页面标题直接命中时从文章标题打开,否则顶部文章入口会优先跳到最相关的小节;落地后会精确居中并短暂聚光命中词、压暗其余视口。
  • 使用方向键选择结果,按 Enter 打开,按 Esc 关闭搜索。

搜索不到时,先减少过长的自然语言描述,保留最有辨识度的关键词。例如把“我在 Windows 上为什么看不到文件后面的名字”缩短为“Windows 文件扩展名”。

三、主题、动效与语言

主题菜单提供浅色、深色和跟随系统三种模式。你可以按阅读环境选择,切换主题不会改变文档内容。

文档侧栏底部的齿轮按钮用于打开动效设置;在移动设备上,可以先打开侧栏找到相同入口。常规动效分为高、中、低三档,实验性动效可以独立开启或关闭。低档仅保留必要的即时状态反馈,并会关闭且禁用实验性动效;从低档或中档切换到高档时,如果当前环境支持所需能力,实验性动效会一并开启。默认设置为高档并开启实验性动效。

动效设置会保存在当前浏览器中,并应用于本站的其它页面。如果操作系统启用了“减少动态效果”,本站会暂时按低档运行并停用实验性动效,但不会覆盖你原来保存的站内选择。当前浏览器或图形环境缺少所需能力时,设置面板会将实验性动效标记为不可用并停止运行相关效果。这个设置不会影响正文和核心操作。

语言菜单用于切换界面语言并访问已有译文,但“界面支持中文与 English”不代表每篇内容都已经完成双语版本。英文内容仍在建设;某一中文页面没有对应译文时,请继续阅读中文版。

四、代码块

代码块顶部会显示语言和复制按钮。若首行是看起来像文件名或路径的注释,还会显示对应位置。

examples/hello.js
console.log('Hello, Neoverse-Docs!');

点击复制按钮可以复制整段代码。部分示例会用语言标签切换同一逻辑的不同写法;标签只改变当前显示的示例,不代表你必须同时学习所有语言。

复制不等于可以直接执行

先确认代码语言、运行环境、路径和可能影响的数据。涉及删除、覆盖、权限、网络下载或账号操作时,更应理解命令后再执行。

五、提示与折叠内容

正文会用不同提示块区分补充信息、建议、重要前提和风险。颜色与图标用于帮助识别语义,真正需要关注的是标题和内容。

折叠内容用于收起可选解释、常见问题或较长示例。点击标题即可展开或收起。

折叠内容必须全部展开吗?

不必。先沿正文完成主要阅读;只有当你需要补充解释、排查问题或查看答案时再展开。

六、任务与进度

文档中的任务项可以直接勾选。开启页面进度概览后,正文顶部会汇总已完成项与任务总数,并提供跳转到任务清单的入口。

任务状态保存在当前浏览器中,不会同步到账号或其他设备。它适合记录“我已经完成并验证了什么”,不应代替你保存实验记录、代码或笔记。

七、Mermaid 图表

Mermaid 图表用文本描述流程、关系或时序。阅读图表时,先理解节点与连线表达的关系,再按需要使用工具栏。

常用操作包括:

  • 在渲染视图与源代码视图之间切换;图表区域获得焦点时也可以按 v
  • 放大或缩小图表,拖动画布查看局部,并用重置按钮恢复初始位置。
  • 最大化图表后查看细节;在最大化状态下可以使用滚轮围绕指针位置缩放,按 Esc 退出。

页面中的“100%”表示图表完整适配当前容器后的基线,不一定等于原始像素尺寸。

八、页面操作与反馈

配置了作者信息的页面会在正文前显示作者。页面操作菜单可以查看 Markdown 源码,或前往 GitHub 查看和编辑对应文件。

文档下方的评论区由 Giscus 提供,加载依赖 GitHub 与当前网络环境;发表内容需要 GitHub 账号。如果评论区暂时不可用,也可以通过 GitHub Issues 反馈问题。

访问不存在的地址时,本站会显示本地化的 404 页面并提供返回入口。标记为草稿的页面会先显示施工提示,表示内容尚未稳定,不应当作已完成章节使用。

面向文档作者的组件写法、Frontmatter 和贡献流程不属于本页范围,可以继续查阅 语法示例贡献指南

本页目录

讨论区

欢迎分享你的想法与建议