Notefix Docs See the demo site

Quick start

Put Notefix on one of your pages and leave your first note. This takes about two minutes and needs nothing but the files.

1Unzip the download

Inside you will find:

notefix/         the four files that go on your site
server/          the store, for sharing notes (later)
connectors/      GitHub, Jira, Trello, Slack and email (later)
README.md
INSTALL.md

2Copy the notefix folder to your site

Put it wherever your site serves static files from. For most sites that is a folder called public, static or wwwroot. After copying, this address should open a JavaScript file:

https://your-site.com/notefix/notefix-embed.js

3Add one line to your page

Paste this just before </body> on the page you want to review:

html
<script src="/notefix/notefix-embed.js" data-project="Acme staging"></script>

data-project is the name shown in Notefix. Use anything that tells people which site this is.

4Open the page and leave a note

Reload the page. The Notefix toolbar waits just past the right edge of the window: move your pointer to that edge and it slides out. To keep it on screen, click the pin at its top.

  1. Click the pin, then click the thing you want to talk about.
  2. Type your name the first time, then your note.
  3. Press Save, or ⌘ Enter.

The note is now pinned to that element. Reload, and it is still there.

Tip

Nothing appears? Nine times out of ten the site's security policy is blocking the files. Open the browser console: Notefix says exactly what was refused. See Troubleshooting.

Where your notes are now#

Right now notes are kept in your browser only. Nobody else can see them, and clearing your browser's data removes them. That is fine for trying it, and for a review on your own.

To let other people see and add notes, run the store. It takes about ten minutes.

Next#