diff --git a/Documentation.md b/Documentation.md index 07374b1..7351f93 100644 --- a/Documentation.md +++ b/Documentation.md @@ -79,7 +79,7 @@ secrets: file: /here/your/path/ewp/hidden_service/hs_ed25519_secret_key ``` -You can tell the Tor Browser that you are offering an `onion` link by specifying +You can tell the Tor Browser that you are offering a `onion` link by specifying your address in the `config.toml` file. ```toml @@ -115,11 +115,11 @@ This file is stored at `/app/data/contacts/links.toml` ``` This is designed by a tuple (service \* optional-scope), -separated by `/` -> `service/optional_scope` +separated by `/` → `service/optional_scope` -- links will be available at `/contact/service/scope` and `/c/service/scope` -- the scope is optional -- you can't stack up scope, only one scope is allowed +- Links will be available at `/contact/service/scope` and `/c/service/scope` +- The scope is optional +- You can't stack up scope, only one scope is allowed > This is _by design_ to keep things easy @@ -151,7 +151,7 @@ tags: Option> Post content ``` -- if no `title`, the filename will be used +- If no `title`, the filename will be used - `date` format is `day-month-year` - `publish` is default to false. When false, posts are hidden from index but accessible, see #30 @@ -194,7 +194,9 @@ Custom project description - `custom` is default to `false`, if `true` all other metadata are ignored, except the `title`, and the markdown will be used instead -- when `custom` is `false` then markdown will be ignored and only metadata will +- When `custom` is `false` then markdown will be ignored and only metadata will be used to create the contact field - `newtab` add property to open in a new tab a link - `user` is the username used in the platform +- `description` will be rendered as HTML "title" (text will appear when cursor + is hover the link)