2 个仓库
Frameworks designed to build technical tutorials and documentation that integrate interactive code components and markdown.
Distinct from React Frameworks: The candidates are general-purpose React application frameworks, while this is a specialized framework for technical documentation and tutorials.
Explore 2 awesome GitHub repositories matching web development · Interactive Documentation Frameworks. Refine with filters or upvote what's useful.
Codehike 是一个基于 React 的文档框架和交互式代码演练工具。它作为一个 Markdown 内容编排器,将修饰后的 Markdown 转换为结构化数据和 React 组件,作为用于高亮代码范围、差异和编译器错误的可视化层。 该项目的特点是能够创建“滚动代码”(scrollycoding)体验和分步技术教程。它具有标记级动画,可直观地演示逻辑如何在代码版本之间演变,并提供了一个将 UI 状态与浏览器滚动位置同步的系统。 该框架涵盖了广泛的可视化功能,包括创建代码幻灯片、聚光灯布局和选项卡式代码块。它支持通过工具提示、标注和脚注进行详细的代码注释,以及语言切换器、代码转译和实时编译器数据集成等功能实用程序。 该系统利用基于模式的验证来确保从 Markdown 文件中提取的结构化数据的类型安全性和一致性。
Provides a comprehensive framework for building interactive technical tutorials and documentation using React and Markdown.
react-live 是一套用于浏览器内 React 转译、实时编辑和交互式文档的工具。它提供了一个 React 组件,用于构建实时演练场,其中源代码可被实时转译和渲染,并配有提供语法高亮和即时视觉反馈的实时代码编辑器。 该项目支持通过嵌入可编辑的 React 代码示例及其渲染输出来创建动态文档。它支持执行可编辑的标记或函数式组件,允许用户修改代码并立即观察结果行为。 该系统包括动态组件渲染、实时代码转译和全局依赖注入功能。它还具备错误处理机制,可在不导致应用程序崩溃的情况下检测并显示编译、语法和执行错误。
Provides a framework for building technical documentation that integrates interactive, editable React code components.