Mak is
a universal notepad

Mak is designed to be instant and intuitive.

People are walking checklists.
Mak provides the most flexible way for managing both your small ideas and big plans.

We have multiple work-in-progress drafts.
Unlike a normal file system, Mak organizes files flatly. No folders. It’s just a list of files.

There’re several preset files in Mak, which are read-only:
#list, #preferences, #profile and #sample. You can access via links or go: command.

If you don’t want to move your hands away from the keyboard, hit Ctrl+Enter when focusing on a link,
or just use the go: command to navigate between files:

You can configure Mak via multiple ways.
The easiest choice is to open the #preferences file:

Mak recognizes [](set:option) as links too, just click on them to apply.
And similar to the go: command, you can also use the set: command to apply settings:

Both settings and content you’re editing will be synced automatically between tabs and stored in your browser.

Gist¹ is a code snippet service provided by GitHub. It’s the easist way to share code snippets or documents with others.
“With gists, you can share single files, parts of files, and full applications with other people.”

You can use Gist to sync your files over the Internet² completely inside Mak.

You can either handle Gists via the status bar:

Or use set: commands in Mak to manipulate Gists:
set:login, set:logout, set:pull, set:push

Once your Gist has been loaded (?gist=id), Mak saves it as a file (#id).

If you “push” a non-gist file, Mak will suggest to create a Gist.
By default, all Gists created in Mak are private and you can always change it to public later.

If you try to push to a Gist that you don’t have the permission, Mak will suggest to fork that Gist.

Note that everyone can READ a Gist (via gist.github.com) if he/she has the Gist ID (so you can view any Gist even you’re not logged in).

Privacy and Security

Mak itself only stores your data inside the browser cache locally (localStorage).
Mak does NOT collect any log from your device or GitHub account.

If you’re using Gist Sync, Mak will create private Gists by default, and will never sync in the background without your permission.

Gist is a product from GitHub. Gist downloading / uploading only happens between your browser and GitHub’s API server.

Caching

Normally the browser will not clean up your local cache. But if you accidentally did that, all your documents will be lost.
Please manually backup (set:export) or sync (Gist) your documents as frequently as possible.

Is This Project Free?

Yes. This project was a HCI experiment at the beginning, and there’re no further plans by now.
It’s also a free software and will be open sourced under the MIT license soon.

Donation

Thanks a lot! How about giving me a star / comment or a tweet?

Why Gist?

Gist is a perfect product. And it’s one of the best tools I’ve ever used.

Gist encourages people to create and share notes and code snippets.
It’s easy to read, write, embed in your website, or discuss with people.

It has versioning too, it’s an important feature for text editors. And Gist is completely free.

Most Importantly, it’s super light-weighted and has the very same design philosophy like Mak.
In some word, Mak is just an interface based on Gist.

Any Alternatives?

There’re many awesome products. Notion, Typora, Left, Write.as, Caret and Tempad are both good tools I love.
Give them a try and find the one fits you well!

A Mobile App?

Sorry but actually I don’t have much time to build the mobile version.
For iOS users I would recommend you the default Notes App by Apple (or Bear for Markdown).

Who Are You?

I’m a Web developer and designer. You can follow me on GitHub and Twitter.
If you have any suggestions for Mak, feel free to open an issue.