aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
-rw-r--r--doc/md/Link-structure.md18
-rw-r--r--mkdocs.yml1
2 files changed, 19 insertions, 0 deletions
diff --git a/doc/md/Link-structure.md b/doc/md/Link-structure.md
new file mode 100644
index 00000000..0a2d0f88
--- /dev/null
+++ b/doc/md/Link-structure.md
@@ -0,0 +1,18 @@
1## Link structure
2
3Every link available through the `LinkDB` object is represented as an array
4containing the following fields:
5
6 * `id` (integer): Unique identifier.
7 * `title` (string): Title of the link.
8 * `url` (string): URL of the link. Used for displayable links (without redirector, url encoding, etc.).
9 Can be absolute or relative for Notes.
10 * `real_url` (string): Real destination URL, can be redirected, encoded, etc.
11 * `shorturl` (string): Permalink small hash.
12 * `description` (string): Link text description.
13 * `private` (boolean): whether the link is private or not.
14 * `tags` (string): all link tags separated by a single space
15 * `thumbnail` (string|boolean): relative path of the thumbnail cache file, or false if there isn't any.
16 * `created` (DateTime): link creation date time.
17 * `updated` (DateTime): last modification date time.
18 \ No newline at end of file
diff --git a/mkdocs.yml b/mkdocs.yml
index a1226e8f..d03bc149 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -35,6 +35,7 @@ pages:
35 - Continuous integration tools: Continuous-integration-tools.md 35 - Continuous integration tools: Continuous-integration-tools.md
36 - GnuPG signature: GnuPG-signature.md 36 - GnuPG signature: GnuPG-signature.md
37 - Directory structure: Directory-structure.md 37 - Directory structure: Directory-structure.md
38 - Link Structure: Link-structure.md
38 - 3rd party libraries: 3rd-party-libraries.md 39 - 3rd party libraries: 3rd-party-libraries.md
39 - Plugin System: Plugin-System.md 40 - Plugin System: Plugin-System.md
40 - Release Shaarli: Release-Shaarli.md 41 - Release Shaarli: Release-Shaarli.md