Skip to content

minhajuddin/readcode

Repository files navigation

Donate Donate

Core TODO

  • Allows you to read all the code of any repository on a single page
  • Syntax highlighting
  • Inline the highlight css
  • Good cache strategy
  • Timeout if we can't load the repo or if the repo is too large
  • Gzip compression for html files
  • Deploy to simplepage.in server
  • Ability to read code for different branches, tags, commits
  • Allow ignoring of files, e.g. ?/vendor
  • A badge to link to the source similar to godoc
  • Sourcegraph examples
  • Epub/PDF/Mobi format export
  • Ability to choose a theme from pygment themes
  • Add ability to minimize folders (reddit tree style)
  • Add post processors for specific types of repositories/files. e.g. a go file should allow clicking on the imports and browsing to the imports repository.
  • Use go oracle and sourcegraph for go repos

Design TODO

  • Make the site look nicer and responsive
  • Add a nice logo

Tech

readcode couldn't have been built without standing on the shoulders of these giants:

About

An app which allows you to read code from a git repository on a single page

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors