Thanks to visit codestin.com
Credit goes to github.com

Skip to content

chongjiayee0156/codebase-tutorial-generator

 
 

Repository files navigation

Turns Codebase into Easy Tutorial with AI

License: MIT

Description

Forking & utilizing the existing repo from the pocket flow, in which they used ai agent to take in <github_repo> and produce Markdown files, I revamped it by adding a frontend that accepts github repo url pass the arguments to backend API. On top of that, I added a markdown parser library to convert all md files to html, including the embedded links. I also added a package of my own to parse mermaid diagram in MD to html, since this feature is not provided as built-in in markdown library, and other 3rd party libraries of parsing mermaid diagram are having param issues following the update of markdown library.

This original AI Agent is created by another AI Agent named PocketFlow through Cursor.

Demo after my addition:

cover photo

About

generate tutorial webpage for codebase with AI

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 82.0%
  • HTML 18.0%