whatisgithub

What is graph-docs-cli?

mattpocock/graph-docs-cli — explained in plain English

Analysis updated 2026-07-11 · repo last pushed 2022-04-16

108TypeScriptAudience · developerComplexity · 2/5DormantSetup · easy

In one sentence

A command-line tool that turns Markdown documentation files into an interactive visual graph showing the ideal reading order, based on dependencies you declare at the top of each file.

Mindmap

mindmap
  root((repo))
    What it does
      Visualizes doc reading order
      Parses markdown dependencies
      Live updates on edit
    Use cases
      Software docs
      Technical courses
      Onboarding guides
    Key rules
      No circular dependencies
      Color-coded categories
      Forces clear structure
    Tech stack
      TypeScript
      CLI tool
      Browser viewer
    Audience
      Doc maintainers
      Course creators
Click or tap to explore — scroll the page freely

Code map

Detail Auto

An interactive map of this repo's files and how they connect — its source is parsed live in your browser. Click Visualize to build it.

filefunction / class

What do people build with it?

USE CASE 1

Structure a software project's documentation so readers follow the correct learning path.

USE CASE 2

Build a technical course with modules that visually show prerequisite relationships.

USE CASE 3

Organize onboarding guides so new hires know what to read first.

USE CASE 4

Untangle existing docs that mix beginner and advanced concepts without a clear order.

What is it built with?

TypeScriptMarkdownCLI

How does it compare?

mattpocock/graph-docs-clijoeseesun/qiaomu-artist-stylepfwjrfp5hh-byte/workmesh
Stars108112104
LanguageTypeScriptTypeScriptTypeScript
Last pushed2022-04-16
MaintenanceDormant
Setup difficultyeasyeasyhard
Complexity2/52/53/5
Audiencedeveloperdesignerpm founder

Figures from each repo's GitHub metadata at analysis time.

How do you get it running?

Difficulty · easy Time to first run · 5min

No notable setup gotchas mentioned, it is a CLI tool that reads Markdown files and opens a browser graph.

The explanation does not mention a license, so it is unknown what permissions are granted for use or distribution.

So what is it?

Graph Docs CLI helps you organize documentation so readers can actually follow along. Instead of writing long pages and hoping people read them in the right order, you break your docs into small, focused modules and declare what each module depends on. The tool then generates a visual graph showing the ideal learning path, what someone needs to understand before tackling any given topic. The workflow is straightforward. You write individual Markdown files for each concept. At the top of each file, you list that module's dependencies, the other modules a reader should understand first. The tool reads these relationships and draws an interactive graph you can view in your browser, updating live as you edit. You can also group modules with color-coded categories like "basics" or "advanced" to keep larger doc sets manageable. This is built for anyone maintaining documentation that people learn from, software projects, technical courses, onboarding guides. The creator, Matt Pocock, developed it while restructuring XState's docs after realizing their pages mixed advanced and beginner concepts with no clear reading order. If you've ever documented something like JavaScript arrow functions and struggled to figure out whether to explain variables or regular functions first, this tool turns that decision into explicit, visible dependencies. One notable design choice: circular dependencies are explicitly forbidden. If module A requires understanding module B, and B requires understanding A, the tool throws an error rather than allowing it. This forces you to resolve the issue, either by splitting out the shared concept into its own module or combining the two into one page. The README notes this is what separates the project from note-taking tools like Obsidian, which allow circular links. Those tools work well for personal notes but can create confusing experiences for other readers who don't share the author's mental model. The project is experimental, with the creator actively seeking feedback. It doesn't yet integrate directly with documentation platforms, though that's on the roadmap.

Copy-paste prompts

Prompt 1
I have a docs folder full of Markdown files. How do I install and use Graph Docs CLI to generate a visual learning graph from them?
Prompt 2
Help me write the dependency frontmatter for a Markdown module about JavaScript arrow functions that depends on modules about variables and regular functions.
Prompt 3
Graph Docs CLI is throwing a circular dependency error between my module A and module B. How can I restructure these docs to resolve it?
Prompt 4
Show me how to group my documentation modules into color-coded categories like basics and advanced using Graph Docs CLI.

Frequently asked questions

What is graph-docs-cli?

A command-line tool that turns Markdown documentation files into an interactive visual graph showing the ideal reading order, based on dependencies you declare at the top of each file.

What language is graph-docs-cli written in?

Mainly TypeScript. The stack also includes TypeScript, Markdown, CLI.

Is graph-docs-cli actively maintained?

Dormant — no commits in 2+ years (last push 2022-04-16).

What license does graph-docs-cli use?

The explanation does not mention a license, so it is unknown what permissions are granted for use or distribution.

How hard is graph-docs-cli to set up?

Setup difficulty is rated easy, with roughly 5min to a first successful run.

Who is graph-docs-cli for?

Mainly developer.

Open on GitHub → Ask about another repo

This repo across BitVibe Labs

Verify against the repo before relying on details.