DEV Community

Cover image for Turn your Github issues into Notes ... Yay ๐Ÿ‘จโ€๐Ÿ’ป๐Ÿ‘ฉโ€๐Ÿ’ป๐ŸคŸโœŒ
Sharad Raj (He/Him)
Sharad Raj (He/Him)

Posted on

Turn your Github issues into Notes ... Yay ๐Ÿ‘จโ€๐Ÿ’ป๐Ÿ‘ฉโ€๐Ÿ’ป๐ŸคŸโœŒ

This theme will turn your repository issues into notes.

Also the color of your labels will be used as color for the tags on the site.

Have a look at this Live demo

How to deploy

First of all make sure you use a private repo because in a public repo anyone will be able to make issues & they will appear on your site.

My repo with issues

Few Labels that I made

  • First step is to change the labels for issues, because you probably dont wanna use the existing labels for your notes, your lables will be used as tags in the notes.
  • Now Fork the project or download
  • Open theme.config.js file and change username and repo name
  • Get a personal access token from github
  • Deploy on vercel and add personal access token as environment variable TOKEN.
  • That's it now your lables will apprear on the sidebar and the issues will apprear on right.

Github Repo: https://github.com/sharadcodes/github-issue-notes-theme


PS: Don't forget to star ๐Ÿ˜„

Oldest comments (7)

Collapse
 
ben profile image
Ben Halpern

Neat!

Collapse
 
sharadcodes profile image
Sharad Raj (He/Him)

Thanks ๐Ÿ™‚๐ŸคŸ

Collapse
 
cgcnu profile image
sreenivas • Edited

This is a nice project. Good job on getting it out.
Every time I see someone use "GitHub-as-a-database" I feel even in the era of cloud, databases are still a little monstery. These kinds of projects shows the need for a simple service with a real simple API. We need a more "friendly neighbourhood database service".

Collapse
 
sharadcodes profile image
Sharad Raj (He/Him)

Thanks ๐Ÿ˜ƒ

Collapse
 
martinadamsdev profile image
Martin Adams

Nice! This is my note address. Martin Note

Collapse
 
sharadcodes profile image
Sharad Raj (He/Him) • Edited

Thanks

Collapse
 
andrewbaisden profile image
Andrew Baisden

Cool project.