UrlMark

Write yourself a home page with bookmarks well-organized, browser-agnostic and easy-to-share.

Demos

Shared browser bookmarks

See http://librecrops.github.io/shared-bookmarks/.

Source lies here, https://github.com/LibreCrops/shared-bookmarks.

Demo based-on awesome-python

A concise awesome list using UrlMark: https://librecrops.github.io/shared-bookmarks/urlmark/awepy/.

• Credits

  Links are from awesome-python.

• Notice

  I made execessive manual editing and rearrangement. Therefore, it may contain errors, but it's merely a demo.

Installation

• pip install git+https://github.com/NoviceLive/urlmark.git

  Lastest Git version.

• pip install urlmark

• Download from Github releases.

• Download from PyPI.

Get Started

• Write the left and right side links in Markdown lists.

  It looks like what follows.

  - [FOSS](#)
      - [Repositories](#)
          - [GitHub](https://github.com/)
          - [Bitbucket](https://bitbucket.org/)
          - [GitLab](https://about.gitlab.com/)
  

• Write a template.

  You can use the included template, but it may not look eyeful.

  See the bundled template to write your own one. It shall setup Foundation scaffold and has three placeholders: {left}, {right}, {time}.

  And all other uses of brackets must be escaped as in Python str.format.

• Run ./urlmark.py with necessary options.

  If you name your left and right side as left.md and right.md, you can just run ./urlmark.py with no options on the residing directory.

  ./urlmark.py --help
  Usage: urlmark.py [OPTIONS]
  
    Write you self a home page with well-organized bookmarks.
  
  Options:
    -l, --left FILENAME      Use this as the left side.  [default: left.md]
    -r, --right FILENAME     Use this as the right side.  [default: right.md]
    -t, --template FILENAME  Use this template.  [default: template.html]
    -o, --output FILENAME    Write to this file.  [default: index.html]
    --help                   Show this message and exit.
  

Command Line Launcher & Intentional Command-Not-Found

UrlMark is intended to be commandline-friendly, which is achieved using intentional command-not-found handler together with our extended interpretation of Markdown.

Warning

This feature is experimental and work in progress, and probably contains hardcoded behaviors, which will be removed gradually.

Consider it as a demonstration of some idea from the author.

Shell Setup

• Install the Git version of UrlMark.

• Use the following pieces of code as your command-not-found handler.

  found "${@}" || return 127
  

  Specifically, for Zsh, add the following to you shell profile.

  command_not_found_handler() {
      found "${@}" || return 127
  }
  

  For Bash users, the following.

  command_not_found_handle() {
      found "${@}" || return 127
  }
  

Basic Show Cases

$ # Search in Google or Bing, and many others.
$ @google Who is the president of US
$ @bing Who is the president of US

$ # Open a website.
$ @github

$ # Search in dictionaries.
$ @oxford pulchritude
$ @urban '<3'

Extended Interpretation

Simply, UrlMark will interpret HTML comments as short names of links.

What follows is an example of this.

- [FOSS](#)
    - [Repository Hosting](#)
        - [GitHub](https://github.com/) <!-- gh -->
        - [Bitbucket](https://bitbucket.org/) <!-- bt -->
        - [GitLab](https://gitlab.com/)

Suppose that the above content resides in a file named left.md, you can then prepare the dataset used by UrlMark using, foundb left.md, (UrlMark is intended to automatically handle data preparation by itself in later updates.), after which you can then type @gh on you terminal to launch your browser, which is hardcoded as firefox for the time being, to the website of Github.

To be described in detail later. But you are always free and encouraged to go ahead and read the source code.

Brainstorm & TODO

• Bugs

  • Remove the hardcoded firefox and use a launcher corresponding to the running system.

    E.g. xdg-open on GNU/Linux, open on MacOS.