Browse Source

img + readme

main
clemtre 5 months ago
parent
commit
f6718602d4
  1. 43
      LISEZMOI.md
  2. 9
      README.md
  3. BIN
      demo.png

43
LISEZMOI.md

@ -1,5 +1,6 @@
# Demo
??
![un gestionnaire de lien navigable](demo.png)
**Quelque chose de plus lisible ici bientôt**
# Presentation
## signet.sh
@ -15,12 +16,12 @@ alternative pour archiver ses navigations internet.
## Format de la base de donné
Seule une Url est requise, le reste des champs sont
facultatifs, on compte les champs suivants :
URL : ...
Name : Par défaut la balise </title> de la page
Description : ...
Tags : mots-clés séparés d'une virgule
Date : heure posix de l'ajout du lien
Color : couleur css (nom, hex, rgb etc...)
* URL : ...
* Name : Par défaut la balise </title> de la page
* Description : ...
* Tags : mots-clés séparés d'une virgule
* Date : heure posix de l'ajout du lien
* Color : couleur css (nom, hex, rgb etc...)
Par exemple, dans un fichier qui s'appelle par défaut BOOKMARKS :
```
@ -120,20 +121,20 @@ awful.util.spawn_with_shell("add.sh") end,
# Structure du répertoire
BOOKMARKS → Une base de donnée de liens
add.sh → Un script pour rajouter un lien dans la base de donné
- dmenu
- ./signet.sh
signet.sh → Le script shell en lui-même
- Il génère une nouvelle page html à partir de la base
de donnés de liens (par défaut index.html)
style.css → La feuille de style pour styliser index.html
script.js → Un peu de javascript pour:
- rechercher dans la \<textarea>
- ajouter les couleurs de fond aux entrées qui en ont
- si le champs de description est vide, ne pas
l'afficher
- formater les dates du temps posix au format AA-MM-JJ
* BOOKMARKS → Une base de donnée de liens
* add.sh → Un script pour rajouter un lien dans la base de donné
* dmenu
* ./signet.sh
* signet.sh → Le script shell en lui-même
* Il génère une nouvelle page html à partir de la base
de donnés de liens (par défaut index.html)
* style.css → La feuille de style pour styliser index.html
* script.js → Un peu de javascript pour:
* rechercher dans la \<textarea>
* ajouter les couleurs de fond aux entrées qui en ont
* si le champs de description est vide, ne pas
l'afficher
* formater les dates du temps posix au format AA-MM-JJ
/!\ Prochainement /!\
starred.sh → Un curl des repos de l'api github
https://api.github.com/users/[user]/starred , formaté de json à une

9
README.md

@ -1,7 +1,7 @@
*FR → LISEZMOI.md*
# Demo
![a browsable bookmark manager](demo.png)
**Something more understendable to be released soon**
**Something more understendable and browsable to be released soon**
# Presentation
## signet.sh
@ -11,7 +11,10 @@ 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. Firefox stores bookmarks in a sqlite format and I
wanted something text based
wanted something text based.
I have been using the generated html page as a default landing page for
three months, it has been a pleasing experience so far.
## Bookmarks database format
Only a Url is required, the rest of the fields are optional :
@ -118,7 +121,7 @@ awful.util.spawn_with_shell("add.sh") end,
{description = "Enregistre le lien copié dans signet.sh"}),
```
# Structure du répertoire
# Repository structure :
* BOOKMARKS → A textual database of bookmarks
* add.sh → A script to add a link to the database

BIN
demo.png

Binary file not shown.

Before

Width:  |  Height:  |  Size: 550 KiB

After

Width:  |  Height:  |  Size: 544 KiB

Loading…
Cancel
Save