Skip to content

dotGuide helps you read code descriptions better. stop writing comments in-line with side-by-side comments!

Notifications You must be signed in to change notification settings

dotArchive/dotGuide

Repository files navigation

< dotGuide />

dotGuide is an amazing tool to help educators, organizations, individuals, and groups alike.

Have you ever remembered that one time you wrote code that solve the exact problem you're encountering right now, but you can't remember which repo it's in, which file, or which branch?

No more wasting time and searching on SO for a quick fix! No more looking through documentation for how a method works and looking at theory! Share with the world examples of real, working code — and why it works.

dotGuide has you covered with side-by-side comparison with code and markdown.

How it works

Add as many files to a "Guide" as you want, each one comes with its own accompanying markdown to help explain what's going on.

Instead of importing your whole repo, or even your whole files, feel free to copy and paste over only what you need.

Need to explain how a vertical slice works? Bring it in in one file or in several.

Need to really zero in on what your hooks are doing in your React project? Explain away.

Future plans

  • GitHub integration and Auth
  • Google Auth
  • Import files directly
  • More comprehensive editing features
  • Jump to line in editor from an MD link
  • Search by multiple keywords
  • Organizations

View Website

dotGuide Website

About

dotGuide helps you read code descriptions better. stop writing comments in-line with side-by-side comments!

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages