@gitgraph/js

中文文档
1.4.0发布于 2021/03/07MITTypeScriptESM + CJS近 30 天下载 7339

Draw pretty git graphs in the browser

原始使用文档
文档目录6 节
  1. 👉 Try it with the online playground
  2. Get started
  3. Browser bundle, ready to use
  4. Usage with a bundler (example with ParcelJS)
  5. More examples
  6. If you're coming from gitgraph.js package

@gitgraph/js

version Changelog

Draw pretty git graphs with vanilla JS.

This is the vanilla JS rendering library of GitGraph.js.

👉 Try it with the online playground

Get started

You have 2 options:

  1. Get GitGraph.js bundle to use directly in your browser
  2. Get GitGraph from npm to use with a JS bundler

Browser bundle, ready to use

Get the bundle from one of the following sources:

Create an index.html file and start coding:

<!DOCTYPE html>
<html>
<head>
  <!-- Load the JS file -->
  <script src="https://cdn.jsdelivr.net/npm/@gitgraph/js"></script>
</head>
<body>
  <!-- DOM element in which we'll mount our graph -->
  <div id="graph-container"></div>

  <!-- Use the `GitgraphJS` global variable to create your graph -->
  <script>
    // Get the graph container HTML element.
    const graphContainer = document.getElementById("graph-container");

    // Instantiate the graph.
    const gitgraph = GitgraphJS.createGitgraph(graphContainer);

    // Simulate git commands with Gitgraph API.
    const master = gitgraph.branch("master");
    master.commit("Initial commit");

    const develop = master.branch("develop");
    develop.commit("Add TypeScript");

    const aFeature = develop.branch("a-feature");
    aFeature
      .commit("Make it work")
      .commit("Make it right")
      .commit("Make it fast");

    develop.merge(aFeature);
    develop.commit("Prepare v1");

    master.merge(develop).tag("v1.0.0");
  </script>
</body>
</html>

Serve your files—with npm, you can run npx serve .

You should see the following graph:

Example of usage

Usage with a bundler (example with ParcelJS)

You need to have npm installed.

Create a new folder for your project and go there: mkdir your-project && cd your-project

Initialize your npm project: npm init -y

Install the package with npm: npm i --save @gitgraph/js

Install Parcel bundler: npm i --save-dev parcel-bundler

Now you can use createGitgraph to render your graph in a DOM element:

Create an index.html file:

<!DOCTYPE html>
<html>
<head>
  <!-- … -->
</head>
<body>
  <!-- DOM element in which we'll mount our graph -->
  <div id="graph-container"></div>

  <!-- This is for ParcelJS bundler -->
  <script src="./index.js"></script>
</body>
</html>

Create an index.js file:

import { createGitgraph } from "@gitgraph/js";

// Get the graph container HTML element.
const graphContainer = document.getElementById("graph-container");

// Instantiate the graph.
const gitgraph = createGitgraph(graphContainer);

// Simulate git commands with Gitgraph API.
const master = gitgraph.branch("master");
master.commit("Initial commit");

const develop = gitgraph.branch("develop");
develop.commit("Add TypeScript");

const aFeature = gitgraph.branch("a-feature");
aFeature
  .commit("Make it work")
  .commit("Make it right")
  .commit("Make it fast");

develop.merge(aFeature);
develop.commit("Prepare v1");

master.merge(develop).tag("v1.0.0");

Add start command in your package.json:

{
  "name": "your-project",
  "version": "1.0.0",
  "scripts": {
+   "start": "parcel index.html"
  }

Run npm start. You should see the following graph:

Example of usage

More examples

A bunch of scenarios has been simulated in our Storybook. Give them a look 👀

If you're coming from gitgraph.js package

Here's a guide to help you migrate to @gitgraph/js.

版本与发布记录

@gitgraph/js 共发布 15 个版本,首次发布于 2019/04/05;过去 12 个月发布了 0 个版本。

版本发布日期距今
1.4.0latest2021/03/075 年前
1.3.52020/04/056 年前
1.3.42020/03/226 年前
1.3.32019/11/196 年前
1.3.22019/07/297 年前
1.3.12019/07/217 年前

关于 @gitgraph/js 的常见问题

@gitgraph/js 是什么?

Draw pretty git graphs in the browser

如何安装 @gitgraph/js?

在项目目录运行 npm install @gitgraph/js,或使用 pnpm add / yarn add / bun add。

@gitgraph/js 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@gitgraph/js 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@gitgraph/js 可以商用吗?

@gitgraph/js 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@gitgraph/js 的下载量有多少?

根据 npm 官方下载统计,@gitgraph/js 在 2026/10/17 – 2026/11/15 这 30 天内被下载 7,339 次,日均约 245 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@gitgraph/js 还在维护吗?

最新版本 1.4.0 发布于 2021/03/07(5 年前);至今共发布 15 个版本,其中过去 12 个月发布了 0 个;首次发布于 2019/04/05。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。