mirror/Notes
1
0
Fork 0
mirror of https://github.com/TriliumNext/Notes.git synced 2026-05-01 01:41:08 -05:00
Code Issues Packages Projects Releases Wiki Activity

feat(docs): add developer guide

Browse Source
This commit is contained in:
Elian Doran
2025-04-12 01:36:03 +03:00
parent 21e84dd95e
commit d2a1655de5
105 changed files with 7098 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/Developer Guide/Developer Guide/Documentation.md
+23
View File
@@ -0,0 +1,23 @@
# Documentation
## Hard-coded links
Hard-coded links are present throughout the application, either in dialogs or in the source code as comments.
You can identify these links by searching for:
```plain
https://triliumnext.github.io/Docs/Wiki/
```
## Help buttons
There is a pattern of “?” buttons throughout the application which make use of the `data-help-page` attribute. Whenever these buttons are pressed, the user is redirected to the corresponding wiki page by prepending the wiki root URL to the `data-help-page` attribute.
Since the current wiki has a different structure than the original, for example to link to [https://github.com/TriliumNext/Docs/blob/main/Wiki/tree-concepts.md](https://github.com/TriliumNext/Docs/blob/main/Wiki/tree-concepts.md) the `data-help-page` attribute must be set to `tree-concepts.md`.
For links to headings, simply add the heading after the `.md`: `tree-concepts.md#prefix`
You can identify those by looking for:
* `.attr("data-help-page"`
* `data-help-page="`