scripsi

Build Status:

Scripsi is an open-source, in-browser note-taking/writing/PIM system, inspired by Workflowy and Notion. A running implementation is available at scripsi.netlify.com. Scripsi is a 100% client-side application written to maximize user's control over their own data.

Introduction

Scripsi organizes information in documents, which are hierarchical trees of nodes. Documents can be nested with arbitrary depth, and may contain thousands of nodes. A single document contains and structures all your information: instead of having a Home document and a Work document, you just have a single document with Home and Work subsections. Users familiar with Workflowy will feel right at home here.

So, if a document is a tree of nodes, what's a "node"? A Scripsi node is basically a block-level element of the document, like a paragraph, header, or code block. Different types of nodes can be mixed and matched to best suit the needs of the document. Some node types can be individually configured.

Usage

A Scripsi document has a similar editing experience to a Workflowy outline. Nodes can be reorganized with drag-and-drop, or using the keyboard shortcuts.

Keyboard Shortcuts

Shortcut	Description
`Enter`	Creates a new child node.
`Shift+Enter`	Creates a new paragraph in the focused node.
`Backspace`	Deletes the focused node (if empty).
`Tab`	Indents/"demotes" the focused node.
`Shift+Tab`	Un-indents/"promotes" the focused node.

Nodes

The simplest node is the Text node, which represents a single paragraph or line of text. A Text node doesn't have any special visual rendering. The node's text can include inline elements like bolding, links, etc. By default, new Scripsi nodes are created as text nodes.

The following types of nodes are currently supported:

Inline Formatting

Within most textual nodes, you can take advantage of some inline formatting elements:

Basic rich text
- Markdown syntax
Tags (#tags and @tags)
LaTeX math formatting

Organization

Scripsi's tree-based structure already provides a method for organizing hierarchical data. There are also some non-hierarchical ways to organize your nodes:

Configuration & Usage

Saving Documents

By default, Scripsi stores your document in your browser's offline storage. This is convenient and fast for getting started, but long-term usage presents a problem: Your notes will be tied to your browser, and there is the possibility that the browser will size-limit or delete the document.

Instead, it's recommended you use one of the other backends available to store your notes. The backends currently supported are:

Dropbox

The Dropbox backend requires a Dropbox access key to be configured in order to back up your data. It saves the document as a single database file in the Scripsi folder on your Dropbox account, plus additional files to store raw data like images or file uploads.

Misc. Ideas

Configurable themes/fonts
Publish to HTML
- Auto-post to blog

Compiling and Deploying

Scripsi compiles to a single HTML file with some bundled JS/CSS/font assets by running npm run build. Since it's just a webpage, it can be deployed anywhere.

Certain things, like OAuth integration, require extra setup between the application (Scripsi) and the backend (e.g. Dropbox). In particular, you can only use one of a specific set of URLs for redirection after authentication is complete. As a result, these integrations will not work except on the "official" Scripsi page. However, you can change the Dropbox client ID and set up your own Dropbox integration for your Scripsi installation.

Developer Tools

npm install       # Install all dependencies

npm test          # run unit tests
npm run test-dev  # Run unit tests with file watching

npm run dev       # serve local dev server with live-reload at localhost:8080

npm run tslint    # run tslint
npm run build     # output minified production build to /build
npm run deploy    # push /build folder to gh-pages branch

luketurner/scripsi