Skip to content
@gitorial-sdk

gitorial-sdk

README.md

gitorial-sdk

Gitorial is a framework for building step by step, interactive tutorials using GIT history.

The first example of this framework can be found here: https://github.com/shawntabrizi/rust-state-machine

The framework does not exist today, but here are some ideas for what it should look like:

  • Easily Manage a Gitorial Repo
    • CLI / UI tooling to easily manage and scaffold compliant git history
    • CLI / UI tooling for managing individual steps in the tutorial
    • CI pipelines to check for Gitorial format compliance
    • CI pipelines to manage a secondary history branch for the Gitorial
      • Tools to revert a Gitorial to a previous point in history
  • Easily Deploy Gitorials to Popular Documentation Frameworks
    • Docusarus
    • MdBook
    • Docsify
    • etc...
  • Specialized Plugins to Enhance Tutorial Experience
    • Custom Code Editors
    • Custom Plugins for Referencing and Jumping to Code
    • Local Code Execution and Tutorial Integration
  • Gitorial Enhancements
    • Framework for public and private tests

Popular repositories Loading

  1. cli cli Public

    CLI Tools for Creating and Managing a Gitorial

    JavaScript 4

  2. gitorial-vscode gitorial-vscode Public

    Interactive VS Code extension for Gitorial‐format tutorials: guides you step-by-step through any Git-based tutorial (e.g. Shawn Tabrizi’s Rust State Machine or NFT Kitties), with live code edition,…

    TypeScript 4 2

  3. .github .github Public

  4. mdbook-template mdbook-template Public

    A starting template for building an mdBook using Gitorial.

    JavaScript

  5. gitorial-docs gitorial-docs Public

    Documentation and specifications for Gitorial - how it works, how to use it

Repositories

Showing 5 of 5 repositories

People

This organization has no public members. You must be a member to see who’s a part of this organization.

Top languages

Loading…

Most used topics

Loading…