Skip to content
organize your links
Branch: master
Clone or download

README.md

targetblank

Build Status Test Coverage

Browser tool to organize links. Pages are defined by a structured document which allows links to be labelled, nested and grouped.

  • Productivity focused Follow links by typing their label and pressing enter.

  • Shareable Pages are publicly readable by anyone with the link.

  • Optimized for performance Aggressive caching, small code bundles and native font stacks.

Document Format

Minimal

version 1
===

Simple

version 1
title=bookmarks
===
example.com
email [mail.google.com]

Detailed

# Everything after a pound character (#), trailing whitespace and empty lines are ignored.

# Documents must start with their version (currently only 1).
version 1

# Document metadata key-value pairs can be added at the top of the document.
key=value

# The "title" key can be used to name the document.
title=Hello World

# The first group starts after the header line.
===

# Group metadata key-value pairs can be added at the start of each group.
# These values are currently ignored, but may be used in the future.
key=value

# Groups hold entries containing a label and a link.
labelled link [example.com]

# Both the label and the link are optional.
label without link
[google.com]
amazon.com

# New groups are started using the group delimiter.
---

# Group entries can be nested using indentation.
entry 1
    entry 2
        entry 3
    entry 4

Development

$ npm run dev

This will launch a local server which watches and serves contents from ./website.

The api is not mocked in dev mode, it points to production endpoints.

The built-in go test command can be used to validate changes to backend code.

Deployment

This project is hosted on AWS and uses Terraform to manage the cloud resources.

The deployment workflow uses GitHub Actions to package and apply changes on every change to master.

License

MIT

You can’t perform that action at this time.