Noted Code

Noted Code is a place to create, share and read high-quality notes on source code. Add notes to code repositories on GitHub or Bitbucket, and view notes that other people have made.

Getting Started

Noted Code lets you add your own notes to any repository on GitHub or Bitbucket. The notes are shown alongside the original code in a more readable form than embedded comments. Noted Code also improves the existing comments in source code by showing them in a similar form. With other improvements to make navigation and comprehension fast and easy, Noted Code helps you understand code better.

For now, all notes made in Noted Code are public, and can be viewed by anyone.

Login

Login to Noted Code with your GitHub or Bitbucket account. You don't need to create a new account or remember another password. Then access all the repositories that you maintain in either of those services, or any public repository in them. You can use both account types at the same time to see repositories on each.

Search

Search notes and repositories from the main page. Find what you want quickly from a simple set of results. Search results from GitHub are provided too.

Access Repositories

Code is stored in repositories outside of Noted Code. The repositories view shows all the places where you have notes. Navigate quickly to any repository with a single click.

Read and Add Notes

Add information to source code in repositories with notes. Notes are attached to a particular line of code, and will follow the content when it changes.

Find every note you've created easily. Your notes are shown in context, with details of their location in each repository. Go straight to a note by following its link.

Use Stars

Place a star on notes from others to indicate that you find them valuable. Star and unstar notes with a single click.

Follow Users

Find notes from specific people easily. Follow people to keep informed when they make or change notes.

Viewing Code

View code in GitHub or Bitbucket repositories directly in Noted Code. In all cases, the latest version of the default branch of the repository is used. Notes and embedded comments are shown alongside the code in an easy-to-read format.

Navigate

Navigate through a repository using the directory listing when at the repository overview, or with the file path displayed when viewing file content.

Use the j, k, n, p, and t shortcuts to navigate in a file.

Embed Comments

Noted Code extracts the embedded comments in source code and displays them alongside the original code rather than inline. Any comments that use Markdown format are rendered appropriately.

See Syntax Coloring

Code is syntax-colored, with auto-detection of the file type. If the detection is not correct, override the filetype from the menu in the navigation bar.

Use the w, e and q keys to cycle through the color themes.

Use Keyboard Controls

Use a range of keyboard shortcuts to improve navigation. Press the ? key to view a cheatsheet for these when viewing a file.

Using Notes

Notes let you add your own information to code in repositories. Because you and everyone else can add notes to any code, Noted Code gives you tools to create, edit, review and filter notes so that good information is available easily. Your notes stay in the right place, even if file content changes.

Create Notes

Add notes to your own or other repositories with a single click on the line of code. Use Markdown formatting in your notes. Lists, text styles, syntax coloring and more are supported.

Notes added to code stay in the right place, even when the code changes.

Edit Notes

Edit your own notes to change their content. Review the formatting help to see what markup can be used.

Ctrl-Enter or -Enter will save the note.

esc will cancel the edit.

Review Changes

Keep track of important notes with stars. View notes made by others sorted on their popularity.

Filter Notes

Select the types of notes that you want to see, including your notes, notes you have starred, other notes and embedded comments.