Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

AgentEditions

将任意知识做成一本可交互的精美教材。 Turn any body of knowledge into a beautiful, interactive textbook.

中文 · English

AgentEditions 是一个面向研究与学习的 Codex Skill:它把论文、官方文档、技术论坛、开源实现与本地材料编排成来源可追溯的多章课程,并默认交付经过视觉验收的 Markdown 与 PDF。需要时,还可加入精确几何、离线交互和 Manim 教学动画。

AgentEditions is a Codex skill for research-led learning. It turns papers, documentation, forums, open-source implementations, and local materials into a source-grounded course—and delivers visually verified Markdown and PDF by default, with exact geometry, offline interaction, and Manim animation when they improve the lesson.

Publication-ready course cover
出版级封面 · Publication-ready cover
Exact geometry in a course
精确几何 · Exact geometry
Typeset course page
图文排版 · Editorial layout
Interactive geometry lesson
可拖拽交互 · Draggable interaction
Embedded Manim teaching video
内嵌 Manim 教学动画 · Embedded Manim lesson

中文

它能做什么

  • 研究到课程:建立证据地图、区分事实与推断,并组织成有先修关系和阅读节奏的多章教程。
  • 默认可出版:交付 Markdown、合并阅读入口、精排 PDF、构建报告、逐页渲染与视觉检查联系表;除非用户明确不要 PDF。
  • 让抽象概念可见:按需使用 Mermaid、Asymptote、JSXGraph 与 Manim,覆盖关系图、精确几何、可拖拽实验和时间性演示。
  • 多主题系统:内置 6 套色彩主题与 4 套封面构图;颜色和封面可独立组合,封面默认带有居中出版社标志。
  • 离线阅读增强:可选生成含交互组件与视频的本地 HTML,同时为 PDF 保留有意义的静态降级图。

三步开始

  1. 安装

    把下面这段话直接发给支持 Skill 安装的 Agent:

    请从这个公开仓库安装 AgentEditions:
    https://github.com/shuhari04/AgentEditions
    
    Skill 位于 skill/agent-editions。请完成安装并验证 SKILL.md 可读,
    然后告诉我是否需要刷新会话才能使用 $agent-editions。
    

    也可以手动安装:

    git clone --depth 1 https://github.com/shuhari04/AgentEditions.git
    mkdir -p ~/.codex/skills
    cp -R AgentEditions/skill/agent-editions ~/.codex/skills/

    如果已存在同名 Skill,请让 Agent 先检查现有版本并安全更新;安装程序不应直接覆盖已有目录。

  2. 刷新 Codex

    重新打开 Codex 或开始一个新线程,确认 $agent-editions 可被识别。

  3. 描述你想学的内容

    使用 $agent-editions,面向有基础的工程师,制作一套关于「主题」的中文系统教程。
    覆盖原理、前沿论文、开源实现与决策框架,输出到 ~/Desktop/topic-course。
    在几何或过程难以仅靠文字理解时加入交互 HTML 或 Manim 动画。
    

你不必指定 PDF:它属于默认完成条件。高级用法、依赖分层和构建参数见 SKILL.md

输出

默认输出 按教学价值启用
多章 Markdown 与合并入口 离线交互 HTML
精排 PDF 与静态媒体 JSXGraph 可拖拽实验
build-report.json、逐页渲染、联系表 Manim 视频与精确几何源码

示例

安全

课程源文件可能包含可执行媒体。JSXGraph 与原始 HTML/JavaScript 只应用于可信作者内容;Manim 代码默认不执行,必须在逐段审阅后显式启用 --allow-executable-media。构建器只访问用户指定的源、输出与临时目录,不发送遥测,并自动脱敏构建报告中的本地根路径。


English

What it does

  • Research to course: builds an evidence map, separates fact from inference, and turns the result into a prerequisite-aware, readable curriculum.
  • Publication by default: delivers Markdown, a merged reading entry, a typeset PDF, build report, rendered pages, and a visual-QA contact sheet—unless PDF is explicitly declined.
  • Makes abstractions visible: uses Mermaid, Asymptote, JSXGraph, and Manim when relationships, exact geometry, direct manipulation, or time are essential to understanding.
  • A real design system: includes 6 color themes and 4 independently selectable cover compositions, each with a centered publisher mark by default.
  • Offline enhancement: can package local interactive HTML and video while preserving meaningful static fallbacks for print.

Start in three steps

  1. Install

    Send the following prompt to an agent that supports Skill installation:

    Install AgentEditions from this public repository:
    https://github.com/shuhari04/AgentEditions
    
    The Skill is located at skill/agent-editions. Complete the installation,
    verify that SKILL.md is readable, and tell me whether I need to refresh the
    session before using $agent-editions.
    

    Or install it manually:

    git clone --depth 1 https://github.com/shuhari04/AgentEditions.git
    mkdir -p ~/.codex/skills
    cp -R AgentEditions/skill/agent-editions ~/.codex/skills/

    If a Skill with the same name already exists, ask the agent to inspect it and update it safely; installers should not overwrite an existing directory.

  2. Refresh Codex

    Reopen Codex or start a new thread, then confirm that $agent-editions is available.

  3. Describe what you want to learn

    Use $agent-editions to create a systematic course on [topic] for engineers with
    basic domain knowledge. Cover principles, frontier papers, open-source systems,
    and a decision framework. Write it to ~/Desktop/topic-course, adding interactive
    HTML or Manim only where geometry or process is hard to understand from prose.
    

You do not need to request a PDF; it is part of the default completion contract. See SKILL.md for the full workflow, dependency tiers, and build options.

Outputs

Default When it improves the lesson
Multi-chapter Markdown and merged entry Offline interactive HTML
Typeset PDF with static media Draggable JSXGraph experiments
build-report.json, rendered pages, contact sheet Manim video and exact-geometry source

Examples

Security

Course sources may contain executable media. Use JSXGraph and raw HTML/JavaScript only with trusted authored content. Manim remains disabled until --allow-executable-media is explicitly supplied after review. The builder accesses only selected source, output, and temporary directories, emits no telemetry, and redacts local roots in build reports.

License

Apache License 2.0

About

Turn research into beautiful, interactive, source-grounded learning editions.

Resources

Stars

2 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages