Static Marks

Travis npm license

Convert your plain bookmark files into a static web app.

🔖 View Live Demo

Quickstart

npm install -g static-marks
static-marks import browser-bookmarks.html > bookmarks.yml
static-marks build bookmarks.yml > bookmarks.html

Installation

npm install -g static-marks
npm install --save static-marks

Usage

static-marks [options] <command>

Options:
  -V, --version               output the version number
  -h, --help                  output usage information

Commands:
  build [options] <files...>  build bookmarks app
  import [options] <file>     import bookmarks from chrome, firefox or pocket

Run static-marks <command> --help to view the usage of a specific command.

Build bookmarks app

static-marks build [options] <files...>

Options:
  -o, --output [file]     output to a file (use stdout by default)
  -t, --title [title]     set document title
  --template-file [file]  use a custom web page template

Examples:

static-marks build bookmarks.yml > bookmarks.html  # Single file
static-marks build files/* > bookmarks.html        # All files at path

Import bookmarks

static-marks import [options] <file>

Options:
  -o, --output [file]  output to a file (use stdout by default)

Examples:

static-marks import exported.html > imported.yml

Features

File format

Bookmark files are written in YAML. There are multiple levels of hierarchy:

Collection:
  - Bucket:
    - Link 1: https://example.com
    - Link 2:
      - https://example.com
    - Link with notes:
      - https://example.com
      - This is a text note
      - Link note: https://example.com</pre>

If multiple files are provided to static-marks, they will become selectable via a menu.

License

Copyright 2019 Darek Kay

This project and its contents are open source under the MIT license.