bookworms

Bookworms

Centralise your bookmarks as YAML configuration and export them into different formats that can be used with your existing tools.

In a large company there are literally thousands of tools, environments and HR system URLs to remember. In a start up there maybe many less but in both scenarios there is probably no authority of truth and if there is, it is often out of date.

This tool is designed to help teams share URLs, keep them updo date and consistent in their tools of choice.

Getting started

First thing you need to do is create your bookmarks YAML configuration, below is an example:

label: Bookworms
description: These are sample bookmarks to teach you how Bookworms works
folders:
  - label: folder 1
    description: This is to describe the folder structure
    folders:
      - label: sub folder 1
        description: This is to describe the sub folder structure
        bookmarks:
          - label: sample url 1
            description: this is used to describe the bookmark
            href: https://www.mywebsite.com
  - label: folder 2
    folders:
      - label: sub folder 2
        bookmarks:
          - label: sample url 2
            description: this is used to describe the bookmark
            href: https://www.mywebsite.com
          - label: sample url 3
            description: this is used to describe the bookmark
            href: https://www.mywebsite.com
      - label: sub folder 3
        bookmarks:
          - label: sample url 4
            description: this is used to describe the bookmark
            href: https://www.mywebsite.com
          - label: sample url 5
            description: this is used to describe the bookmark
            href: https://www.mywebsite.com

• label - The heading of your bookmarks or the folder
• description - Generates a HTML comment or text within markdown
• folders - A way of grouping together bookmarks, you can nest these as deep as you like
• bookmarks - How you group the information for a bookmark link
• href - The URL you want to bookmark

Once this is ready you can pass it to Bookworms using npx.

npx bookworms get ./my-bookmarks.yaml

This will then generate in the ./ folder the different exports you can then use in your older tools.

$ cd output
$ ls
browsers.html readme.md

You can also fetch bookmarks from a remote location and output the exports into a directory:

npx bookworms get https://raw.githubusercontent.com/thearegee/bookworms/main/demo/config/bookmarks.yaml -d="./output"

For more information about how to use these files see: Using your bookmarks

Help

If you need help using Bookworms you can run this command:

npx bookworms --help

If you want to understand more about Bookworms you can read the following:

• Using your bookmarks
• For developers

Todo

• Support for other tools for bookmarks
  • Notion
  • Google docs
• Support multiple YMAL files and merging together
• Bug fix markdown generator header folder depth
• Convert existing exported bookmarks into YAML
• Improve documentation for using bookworms modules
• Allow users to select the exports they want or won't want
• Set up GitHub actions for repo to build, test and publish in NPM

Future

• Create GitHub action to update bookmark repos without npx
• Remove step for people to need to import files in browser
• Add the idea of public bookmarks which could genate trends