zadam/trilium
1
1
Fork 0
mirror of https://github.com/zadam/trilium.git synced 2025-01-27 09:29:43 +08:00
Code Issues Projects Releases Packages Wiki Activity

added doc folder

Browse source
This commit is contained in:
azivner 2017-12-10 23:21:47 -05:00
parent fa8b5d41dd
commit bdeaa2829d
4 changed files with 55 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
doc/0001-Welcome to Trilium!.html Normal file
View file

@ -0,0 +1,21 @@
<p>Trilium is a personal knowledge base tool. This allows you to write and
manage your knowledge in a structured manner.</p>
<h3>Main features</h3>
<ul>
<li>hierarchical (tree) structure of notes - notes can be easily nested as
necessary without imposing any depth limitations
<ul>
<li>extension of tree structure in the form of note clones - note can belong
to multiple parent notes - thus appearing in multiple places in the hierarchy</li>
</ul>
</li>
<li>strong encryption - selected notes can be protected with strong encryption
with key derived from password</li>
<li>web application to be deployed on your server, desktop application (build
on Electron) and data synchronization between instances</li>
<li>fast keyboard-based navigation between different notes using "Jump-to"
and "Recent notes" dialogs</li>
</ul>
<h3>Homepage</h3>
<p>Trilium project is maintained in <a href="https://github.com/zadam/trilium">GitHub repository</a> where
you can find up to date documentation, source code and you can file issues.</p>

19
doc/0001-Welcome to Trilium!/0000-Protected notes.html Normal file
View file

@ -0,0 +1,19 @@
<p>Protected notes are encrypted using AES encryption algorithm where encryption
key is generated using Scrypt key derivation function from user entered
password.</p>
<p>&nbsp;</p>
<p>You can either protect individual notes or whole subtree by right clicking
on an item in the tree pane. In such a case it's still a case of all of
the notes being encrypted individually. One consequence is that you can
still create unprotected notes under protected notes.</p>
<p>&nbsp;</p>
<p>In protected notes, only note title and note text are encrypted. All metadata
like date of last modification, note structure etc. are not encrypted and
can be visible even without entering protected mode.</p>
<p>&nbsp;</p>
<p>When you try to perform action which requires protected session (e.g.
reading protected notes or making note protected), you'll be asked to enter
password. After successful authentication, protected session is established
for limited period of time (by default 10 minutes). If protected session
is not refreshed during this time, protected session expires and user needs
to authenticate again to start new protected session.</p>

12
doc/0001-Welcome to Trilium!/0001-Note cloning.html Normal file
View file

@ -0,0 +1,12 @@
Note cloning allows you to "register" single note (and it's subtree) under
multiple different notes.&nbsp;
<p>&nbsp;</p>
<p>This allows the same note to appear in multiple places in the tree. This
is useful when note logically belongs to multiple categories - e.g. in
time based structure you can categorize the note for the given date and
then separately you might want to put it somewhere else by it's taxonomy.
In this sense it works similarly to tags, only more generally and in a
tree structure (while tags are typically flat structured).</p>
<p>&nbsp;</p>
<p>When note has multiple parents, then technically there isn't any one "original"
and "clones", all of the parents are equal.</p>

3
doc/0001-Welcome to Trilium!/0002-Synchronization.html Normal file
View file

@ -0,0 +1,3 @@
<p>Trilium supports synchronization between different instances. Typical
scenario is when you have web version of Trilium deployed on your server
and desktop builds on your personal and work computer (star shaped topology).</p>