https://github.com/ribbity-org/ribbity

Software to turn GitHub issue trackers into mkdocs Web sites.
https://github.com/ribbity-org/ribbity

mkdocs ribbity

Last synced: 13 days ago
JSON representation

Software to turn GitHub issue trackers into mkdocs Web sites.

• Host: GitHub
• URL: https://github.com/ribbity-org/ribbity
• Owner: ribbity-org
• License: other
• Created: 2022-05-08T13:27:58.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2022-10-14T14:49:15.000Z (over 2 years ago)
• Last Synced: 2025-04-12T23:08:52.551Z (13 days ago)
• Topics: mkdocs, ribbity
• Language: Python
• Homepage: https://ribbity-org.github.io/ribbity-docs/
• Size: 938 KB
• Stars: 8
• Watchers: 1
• Forks: 2
• Open Issues: 21
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# ribbity

[![Build Status](https://github.com/ribbity-org/ribbity/workflows/Test/badge.svg)](https://github.com/ribbity-org/ribbity/actions/)





Hop, frog, hop!

Turn a bunch of GitHub issues into a [mkdocs](https://www.mkdocs.org/)

site.

For example, turn

[the sourmash-bio/sourmash-examples issue tracker](https://github.com/sourmash-bio/sourmash-examples/issues/)

into [this site](https://sourmash-bio.github.io/sourmash-examples/).

## Project information

You can see the introductory blog post here: [Announcing ribbity - a hacky project to build Web sites from GitHub issue trackers](http://ivory.idyll.org/blog/2022-announcing-ribbity-github-issue-munging.html).

tl;dr Ribbity turns GitHub issue trackers into mkdocs sites that can be

hosted via GitHub pages.

If you want to see ribbity in action, we have a sandbox repo where you can play with it a bit!

* first, add an issue [over at ribbity-sandbox](https://github.com/ribbity-org/ribbity-sandbox/issues)!

* then, go to [the rendered sandbox site](https://ribbity-org.github.io/ribbity-sandbox/) and search for your issue text!

See ribbity documentation [here](https://ribbity-org.github.io/ribbity-docs/) and visit the source code [on GitHub](https://github.com/ribbity-org/ribbity).

---

Ribbity is released under the [BSD 3-Clause license](https://github.com/ribbity-org/ribbity/blob/main/LICENSE).

Please file issues [on GitHub](https://github.com/ribbity-org/ribbity/issues).