FR → LISEZMOI.md
Work in progress, if you encounter any issues regarding installation or understanding what this is all about, please send an email to [email protected] or open an issue here and i'll be happy to answer
A browsable webpage generated from a textual database you might want to use as a browser homepage. You can edit the database by editing the file called BOOKMARKS or by running the provided script called edit_bookmarks_dmenu.sh (requires dmenu). Signet.sh is the name of the repository in reference to the name of the core script (more on the naming bellow). The script can be ran from the command line but I suggest to bind it to a keystroke combination.
It produces the following html document :
index.html
Key: value fields :
BOOKMARKS
URL: http://fileformats.archiveteam.org/wiki/HEX_(Unifont)
Name: HEX (Unifont) - Just Solve the File Format Problem
Description:
Tags: bbb, hex
Date: 1704636690
Color: Pink
URL: http://robhagemans.github.io/monobit/
Name: Hoard of bitfonts
Description: Bitmap fonts collection
Tags: bitmap, fonts
Date: 1704639859
URL: https://en.wikipedia.org/wiki/Wish_(Unix_shell)
Name: wish (Unix shell) - Wikipedia
Description: a Tcl interpreter extended with Tk commands for unix.
Tags: gui, wish, tcl
Date: 1704646543
URL: https://www.kreativekorp.com/
Name: Rebecca G. Bettencourt
Description:
Tags: RGB, people, hide
Date: 1704648764
Given this database, signet will color the first link in pink and hide the last one because of its "hide" tag.
- First step
Clone this repository, make signet.sh executable and run signet.sh by specifying a file of bookmarks to process and redirect its output to an html file.
git clone https://git.vvvvvvaria.org/clemtre/signet.sh.git
cd signet.sh
chmod +x signet.sh
./signet.sh BOOKMARKS > index.html
- A sample database of bookmarks
You can try signet.sh with this 32kb example BOOKMARKS database :
curl -O https://martinlemaire.fr/signet.sh/BOOKMARKS
- Junicode typeface
You might be in search of a condensed font in order to fit more characters per line, if that's the case I can recommend the condensed light version of Junicode, an OFL typeface drawn by Peter Baker. You can get mirrored versions Junicode condensed light and its italic style (1.8Mb total) from the 50Mb archive here :
# from https://github.com/psb1558/Junicode-font/releases/tag/v2.206
curl -O https://martinlemaire.fr/fonts/Junicode-CondensedLight.otf
curl -O https://martinlemaire.fr/fonts/Junicode-CondensedLightItalic.otf
- dmenu
https://askubuntu.com/questions/828450/how-to-install-dmenu
Signet.sh is a shell script parsing a bookmark database to a webpage. It uses awk inside a here-doc declaration redirected to an html file.
I have created this script because I found the bookmarks manager from firefox not great to use, to the point where I did not have the habit to bookmark my browsing journeys. Firefox stores bookmarks in a sqlite which is not human readable. Although it allows an export in json and html, I wanted something text based and personal.
Only a Url is required, the rest of the fields are optional :
- URL : the url pasted from the clipboard (exits if no url given)
- Name : grabs </title> from the bookmarked page with curl
- Description : a description from the user
- Tags : comma separated keywords
- Date : posix time of the bookmarked link
- Color : css color (name, hex, rgb etc...)
\<!DOCTYPE html>
<html>
<head>
<title>⛵ → YY-MM-DD, H:M</title>
<script defer src="script.js"></script>
<link rel="stylesheet" href="style.css">
<meta charset="utf-8" />
</head>
<body>
<div id="cc"></div>
<textarea autofocus></textarea>
<nav>
<p>tag (amount)</p>
</nav>
<ol>
<li>
<a href="URL">
<section color="Color">
<h5>URL</h5>
<h1>Name</h1>
<h2>Description</h2>
<h3>Tags</h3>
<h4>Date</h4>
</section>
<a>
</li>
</ol>
<footer></footer>
</body>
</html>
To add a link, I select the URL of the page with Ctrl + l, then copy to clipboard and run add.sh with Super + i.
If anyone knows how to retrieve the url of the current browser page without having to copy it and send it to clipboard, this would save two steps out of three.
In short : Ctrl + l, Ctrl + c, Super + i
(or shorter : Ctrl + l + c, Super + i)
Super + i because in my window manager (awesomewm) configuration file located in ~/.config/awesome/rc.lua, I have the following lines:
awful.key({modkey}, "i", function()
awful.util.spawn_with_shell("interface_dmenu.sh ~/BOOKMARKS") end,
{description = "Add a bookmark to my database of bookmarks"}),
Use your text editor of choice. Open the BOOKMARKS file and edit the entry. The last entry is at the bottom.
If you use vim, with BOOKMARKS opened you can press in normal mode m + B and it will save a mark to the file you can then access with ' + B
Works on Ubuntu 20 LTS, it should work on POSIX compliant machines, macOS, linux* or *bsd. I'm curious to know how it goes on windows :^)
To add a link via the proposed interface, we will need
to install dmenu and htmlq.
- dmenu https://tools.suckless.org/dmenu/ (MIT/X)
htmlq https://github.com/mgdm/htmlq (MIT)replaced by one awk command, this was needed in order ot retrieve the <title> tag from the grabbed page- xclip ?
Dmenu is an interactive menu that allows us to select and write values in a menu. These values can come from a program provided as input from a pipe "|", for example:
ls | dmenu
displays a drop-down menu with the files in my directory. In our script, to store the given tags in a variable, we can do:
tags=$(echo "" | dmenu -p "Enter comma-separated tags:")
- BOOKMARKS → A textual database of bookmarks
- interface_dmenu.sh → A script to add a link to the database using
dmenu
- Usage : ./interface_dmenu.sh BOOKMARKS
- signet.sh → The shell script itself
- It generates a new html page from the database of bookmarks
- Usage : ./signet.sh BOOKMARKS > index.html
- style.css → Stylesheet for index.html
- script.js → A bit of vanilla javascript in order to:
- search in the <textarea>
- add background colors to entries that have them
The name is subject to change. Victor suggested signet, it stands for the actual pieces of paper used as bookmarks inserted between the pages of a bound object → https://www.cnrtl.fr/definition/signet
- nb https://xwmx.github.io/nb/ (AGPL-3.0)
- ??
- Junicode (OFL-1.1) https://psb1558.github.io/Junicode-font/
- dmenu (MIT/X) https://tools.suckless.org/dmenu/
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent