typos
This commit is contained in:
parent
9692a8214a
commit
d8dbe579f1
52
README.md
52
README.md
|
|
@ -1,15 +1,16 @@
|
||||||
# [stilde][stilde_repo]
|
# [stilde][stilde_repo]
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
**stilde** is the template for my personal startpage.
|
**Stilde** is the template for my personal static Startpage protected by encryption.
|
||||||
|
|
||||||
The startpage by itself is a lightly modified version of the **[tilde][tilde_repo]** project by [cade](https://github.com/xvvvyz).
|
The startpage is a lightly modified version of the **[tilde][tilde_repo]** project by [cade](https://github.com/xvvvyz).
|
||||||
|
|
||||||
I use it both locally (localhost file) and self-hosted (https), that's why I wanted a way to protect the page that would still stay light, static and bypassable by an action-less uri.
|
I use it both locally (localhost) and self-hosted (https), that's why I wanted a way to protect the page that would still stay light, static and bypassable by an action-less URI.
|
||||||
|
|
||||||
Stilde include **[staticrypt][staticrypt_repo]** for that purpose and provide an authentification form to decrypt the page locally by password or by a decryption uri without any other input.
|
Stilde includes **[staticrypt][staticrypt_repo]** for that purpose and provides an authentification form to decrypt the page locally by password or by a secret decryption URI.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
@ -18,22 +19,22 @@ Stilde include **[staticrypt][staticrypt_repo]** for that purpose and provide an
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
- All tilde features.
|
- Original [tilde][tilde_repo] features:
|
||||||
- Redirect to a bookmarked website.
|
- Redirect to a bookmarked website.
|
||||||
- Run a search on a bookmarked website.
|
- Run a search on a bookmarked website.
|
||||||
- Get search suggestions from DuckDuckGo.
|
- Get search suggestions from DuckDuckGo.
|
||||||
- Redirect to a specific path or uri for a bookmarked website.
|
- Redirect to a specific path or uri for a bookmarked website.
|
||||||
- Access any other url.
|
- Access any other url.
|
||||||
- Lauch a search on a customized DuckDuckGo session for anything outside the scope.
|
- Lauch a search on a customized DuckDuckGo session for anything outside the scope.
|
||||||
- WebCrypto html encryption with password prompt.
|
- New: toggle the input field by clicking on the logo (useful for mobile browsers).
|
||||||
- Direct decryption by secret hash uri.
|
- WebCrypto html encryption with password prompt page.
|
||||||
- Deployment and re-deployment with one command.
|
- Direct link decryption by secret hash URI.
|
||||||
|
- Deployment and re-deployment with a simple build script.
|
||||||
- New: custom logo on both form and startpage.
|
- New: custom logo on both form and startpage.
|
||||||
- New: toggle the input field by clicking on the logo (useful for mobile browsers)
|
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
UNLICENCED : like the original tilde project.
|
UNLICENCED : like the original [tilde][tilde_repo] project.
|
||||||
|
|
||||||
## Requirements
|
## Requirements
|
||||||
|
|
||||||
|
|
@ -51,7 +52,7 @@ cd stilde
|
||||||
|
|
||||||
## Preparation (optional)
|
## Preparation (optional)
|
||||||
|
|
||||||
- Edit french strings for the staticrypt form in `build.sh`:
|
- Edit strings in french in `build.sh` (for the staticrypt form):
|
||||||
|
|
||||||
``` bash
|
``` bash
|
||||||
85 │ --template-button "DECRYPTER" \
|
85 │ --template-button "DECRYPTER" \
|
||||||
|
|
@ -61,7 +62,7 @@ cd stilde
|
||||||
89 │ --template-remember "Se souvenir de moi" \
|
89 │ --template-remember "Se souvenir de moi" \
|
||||||
```
|
```
|
||||||
|
|
||||||
- Edit graphical asset in `assets/root/`:
|
- Edit graphical assets in `assets/root/` (they will be copied to the destination with the encrypted html):
|
||||||
- favicon.ico (`convert icon-512.png -define icon:auto-resize="48,32,16" favicon.ico`)
|
- favicon.ico (`convert icon-512.png -define icon:auto-resize="48,32,16" favicon.ico`)
|
||||||
- favicon.svg (square logo, width 192px)
|
- favicon.svg (square logo, width 192px)
|
||||||
- icon-192.png (generated from favicon.svg)
|
- icon-192.png (generated from favicon.svg)
|
||||||
|
|
@ -70,7 +71,7 @@ cd stilde
|
||||||
|
|
||||||
- Replace the svg logo in the startpage `assets/source/index.html`:
|
- Replace the svg logo in the startpage `assets/source/index.html`:
|
||||||
|
|
||||||
I exported mines from inkscape, cleaned it's code and renamed paths to use them in css and scripts.
|
- I exported mines from inkscape, cleaned it's code and renamed paths to use them in css and scripts.
|
||||||
|
|
||||||
``` html
|
``` html
|
||||||
622 │ <div class="box-container">
|
622 │ <div class="box-container">
|
||||||
|
|
@ -80,7 +81,7 @@ I exported mines from inkscape, cleaned it's code and renamed paths to use them
|
||||||
656 | ...
|
656 | ...
|
||||||
```
|
```
|
||||||
|
|
||||||
There are also some css rules for the logo paths:
|
- There are also some css rules for the logo paths:
|
||||||
|
|
||||||
``` css
|
``` css
|
||||||
607 │ #logo path#characters {
|
607 │ #logo path#characters {
|
||||||
|
|
@ -98,7 +99,7 @@ There are also some css rules for the logo paths:
|
||||||
619 │ }
|
619 │ }
|
||||||
```
|
```
|
||||||
|
|
||||||
And some javascript too:
|
- And some javascript too:
|
||||||
|
|
||||||
``` javascript
|
``` javascript
|
||||||
339 │ const shadows = document.querySelector('#logo path#shadows');
|
339 │ const shadows = document.querySelector('#logo path#shadows');
|
||||||
|
|
@ -108,6 +109,8 @@ And some javascript too:
|
||||||
|
|
||||||
## Bookmarks & Commands
|
## Bookmarks & Commands
|
||||||
|
|
||||||
|
**The real content of the Startpage** and define the list of matching websites, search patterns, custom URIs and suggestions.
|
||||||
|
|
||||||
All of them are included inside the `COMMANDS` const after line 41 of `assets/source/index.html`.
|
All of them are included inside the `COMMANDS` const after line 41 of `assets/source/index.html`.
|
||||||
|
|
||||||
I left enough examples to understand the syntax.
|
I left enough examples to understand the syntax.
|
||||||
|
|
@ -136,14 +139,21 @@ Example: ./build.sh -u https://start.domain.tld -d static -t "STILDE - StartPage
|
||||||
|
|
||||||
## Basic Usage
|
## Basic Usage
|
||||||
|
|
||||||
- **Open a website**: type the corresponding key and press return, or click on the link.
|
- **Open a website**:
|
||||||
- **Open a specific path on a site**: type the path after the site’s key and press return.
|
type the corresponding key and press return, or click on the link.
|
||||||
- **Run a search on a website**: type a space after the website’s key followed by your query and press return.
|
|
||||||
- **Perform a search with DuckDuckGo**: input any string that doesn't match a key and press return.
|
|
||||||
|
|
||||||
- Under your input **suggestions** will be displayed, they are **specific to a key** or **from DuckDuckGo**. Use press up/down/return or click to use them.
|
- **Open a specific path on a site**:
|
||||||
|
type the path after the site’s key and press return.
|
||||||
|
|
||||||
- On mobile devices you can open/close the input and you keyboard by a touch on the logo.
|
- **Run a search on a website**:
|
||||||
|
type a space after the website’s key followed by your query and press return.
|
||||||
|
|
||||||
|
- **Perform a search with DuckDuckGo**:
|
||||||
|
input any string that doesn't match a key and press return.
|
||||||
|
|
||||||
|
- **suggestions** may be displayed under your input, they are **specific to a key** or construicted **from DuckDuckGo** background queries. Use press up/down/return or click to use them.
|
||||||
|
|
||||||
|
- **On mobile devices** you can open/close the input and you keyboard by a touch on the logo.
|
||||||
|
|
||||||
|
|
||||||
----
|
----
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue