Skip to content

Commit c3c70a6

Browse files
gsantnergsantner
committed
Add additional documentation files to doc folder, add readme navigation index
1 parent cd5d8a6 commit c3c70a6

14 files changed

+599
-24
lines changed

‎NEWS.md

+38-21
Original file line numberDiff line numberDiff line change
@@ -20,26 +20,43 @@ If you have questions or found an issue please head to the [Markor project](http
2020
[Search](https://github.com/gsantner/markor/issues?q=#js-issues-search) for same/similar and related issues/questions before, it might be already answered or resolved.
2121

2222

23-
### Navigation
24-
* [Markor v2.10 - Custom file templates, Share Into remove URL tracking parameters](#markor-v210---custom-file-templates-share-into-remove-url-tracking-parameters)
25-
* [Markor v2.9 - Snippets, Templates, Graphs, Charts, Diagrams, YAML front-matter, Chemistry](#markor-v29---snippets-templates-graphs-charts-diagrams-yaml-front-matter-chemistry)
26-
* [Markor v2.8 - Multi-selection for todo.txt dialogs](#markor-v28---multi-selection-for-todotxt-dialogs)
27-
* [Markor v2.7 - Search in content, Backup & Restore settings](#markor-v27---search-in-content-backup--restore-settings)
28-
* [Markor v2.6 - Zim Wiki, Newline = New Paragraph, Save Format](#markor-v26---zim-wiki-newline--new-paragraph-save-format)
29-
* [Markor v2.5 - Zim Wiki - Search & Replace - Zettelkasten](#markor-v25---zim-wiki---search--replace---zettelkasten)
30-
* [Markor v2.4 - All new todo.txt - Programming language syntax highlighting](#markor-v24---all-new-todotxt---programming-language-syntax-highlighting)
31-
* [Markor v2.3 - Table of Contents, Custom Action Order](#markor-v23---table-of-contents-custom-action-order)
32-
* [Markor v2.2 - Presentations, Voice notes, Markdown table editor](#markor-v22---presentations-voice-notes-markdown-table-editor)
33-
* [Markor v2.1 - Key-Value highlighting (json/ini/yaml/csv), improved performance](#markor-v21---key-value-highlighting-jsoniniyamlcsv-improved-performance)
34-
* [Markor v2.0 - Search, dotFiles, PDF export](#markor-v20---search-dotfiles-pdf-export)
35-
* [Markor v1.8 - All new file browser, favourites and faster Markdown preview](#markor-v18---all-new-file-browser-favourites-and-faster-markdown-preview)
36-
* [Markor v1.7 - Custom Fonts, LinkBox with Markdown](#markor-v17---custom-fonts-linkbox-with-markdown)
37-
* [Markor v1.6 - DateTime dialog - Jekyll and KaTex improvements](#markor-v16---datetime-dialog---jekyll-and-katex-improvements)
38-
* [Markor v1.5 - Multiple windows, Markdown tasks, theming](#markor-v15---multiple-windows-markdown-tasks-theming)
39-
* [Markor v1.2 - Markdown with KaTex/Math - Search in current document](#markor-v12---markdown-with-katexmath---search-in-current-document)
40-
* [Markor v1.1 - Markdown picture import from gallery and camera](#markor-v11---markdown-picture-import-from-gallery-and-camera)
41-
* [Markor v1.0 - Widget shortcuts to LinkBox, ToDo, QuickNote](#markor-v10---widget-shortcuts-to-linkbox-todo-quicknote)
42-
* [Markor v0.3 - Faster loading, LinkBox added, Open link in browser TextAction](#markor-v03---faster-loading-linkbox-added-open-link-in-browser-textaction)
23+
## Navigation
24+
* [**README**](README.md)
25+
* [Features](README.md#features)
26+
* [Contribute](README.md#contribute)
27+
* [Develop](README.md#develop)
28+
* [Privacy](README.md#privacy)
29+
* [License](README.md#license)
30+
* [**FAQ**](README.md#FAQ)
31+
* [File browser, file management](README.md#file-browser--file-management)
32+
* [Format: Markdown](README.md#format-markdown)
33+
* [Format: Markdown](README.md#format-markdown)
34+
* [Format: todo.txt](README.md#format-todotxt)
35+
* [**More**](doc)
36+
* [Synced plaintext TODO and notes - Vim / Vimwiki, Markor Android, Syncthing, GTD (Pitt)](doc/2020-09-26-vimwiki-sync-plaintext-to-do-and-notes-todotxt-markdown.md#readme)
37+
* [Markor: How to synchronize files with Syncthing (wmww,tengucrow)](doc/2020-04-04-syncthing-file-sync-setup-how-to-use-with-markor.md#readme)
38+
* [Using Markor to Write (and More) on an Android Device (The Plain Text Project)](doc/2019-07-16-using-markor-to-write-on-an-android-device-plaintextproject.md#readme)
39+
* [How I Take Notes With Vim, Markdown, and Pandoc (Vaughan)](doc/2018-05-15-pandoc-vim-markdown-how-i-take-notes-vaughan.md#readme)
40+
* [**NEWS**](NEWS.md)
41+
* [Markor v2.10 - Custom file templates, Share Into automatically remove URL tracking parameters](NEWS.md#markor-v210---custom-file-templates-share-into-automatically-remove-url-tracking-parameters)
42+
* [Markor v2.9 - Snippets, Templates, Graphs, Charts, Diagrams, YAML front-matter, Chemistry](NEWS.md#markor-v29---snippets-templates-graphs-charts-diagrams-yaml-front-matter-chemistry)
43+
* [Markor v2.8 - Multi-selection for todo.txt dialogs](NEWS.md#markor-v28---multi-selection-for-todotxt-dialogs)
44+
* [Markor v2.7 - Search in content, Backup & Restore settings](NEWS.md#markor-v27---search-in-content-backup--restore-settings)
45+
* [Markor v2.6 - Zim Wiki, Newline = New Paragraph, Save Format](NEWS.md#markor-v26---zim-wiki-newline--new-paragraph-save-format)
46+
* [Markor v2.5 - Zim Wiki - Search & Replace - Zettelkasten](NEWS.md#markor-v25---zim-wiki---search--replace---zettelkasten)
47+
* [Markor v2.4 - All new todo.txt - Programming language syntax highlighting](NEWS.md#markor-v24---all-new-todotxt---programming-language-syntax-highlighting)
48+
* [Markor v2.3 - Table of Contents, Custom Action Order](NEWS.md#markor-v23---table-of-contents-custom-action-order)
49+
* [Markor v2.2 - Presentations, Voice notes, Markdown table editor](NEWS.md#markor-v22---presentations-voice-notes-markdown-table-editor)
50+
* [Markor v2.1 - Key-Value highlighting (json/ini/yaml/csv), improved performance](NEWS.md#markor-v21---key-value-highlighting-jsoniniyamlcsv-improved-performance)
51+
* [Markor v2.0 - Search, dotFiles, PDF export](NEWS.md#markor-v20---search-dotfiles-pdf-export)
52+
* [Markor v1.8 - All new file browser, favourites and faster Markdown preview](NEWS.md#markor-v18---all-new-file-browser-favourites-and-faster-markdown-preview)
53+
* [Markor v1.7 - Custom Fonts, LinkBox with Markdown](NEWS.md#markor-v17---custom-fonts-linkbox-with-markdown)
54+
* [Markor v1.6 - DateTime dialog - Jekyll and KaTex improvements](NEWS.md#markor-v16---datetime-dialog---jekyll-and-katex-improvements)
55+
* [Markor v1.5 - Multiple windows, Markdown tasks, theming](NEWS.md#markor-v15---multiple-windows-markdown-tasks-theming)
56+
* [Markor v1.2 - Markdown with KaTex/Math - Search in current document](NEWS.md#markor-v12---markdown-with-katexmath---search-in-current-document)
57+
* [Markor v1.1 - Markdown picture import from gallery and camera](NEWS.md#markor-v11---markdown-picture-import-from-gallery-and-camera)
58+
* [Markor v1.0 - Widget shortcuts to LinkBox, ToDo, QuickNote](NEWS.md#markor-v10---widget-shortcuts-to-linkbox-todo-quicknote)
59+
* [Markor v0.3 - Faster loading, LinkBox added, Open link in browser TextAction](NEWS.md#markor-v03---faster-loading-linkbox-added-open-link-in-browser-textaction)
4360

4461

4562

@@ -50,7 +67,7 @@ If you have questions or found an issue please head to the [Markor project](http
5067
------------------------------------------------------------------------------------------------------------------------------------
5168

5269

53-
# Markor v2.10 - Custom file templates, Share Into remove URL tracking parameters
70+
# Markor v2.10 - Custom file templates, Share Into automatically remove URL tracking parameters
5471
_16. July 2022_
5572

5673

‎README.md

+44-3
Original file line numberDiff line numberDiff line change
@@ -42,8 +42,49 @@ Markor is openly developed free software that accepts community contributions.
4242
<br/>👌 No ads or unnecessary permissions
4343
<br/>🌎 Language selection -- use other language than on the system
4444
<br/>
45-
<br/>🔃 Markor is an offline app. It works with sync apps, but they have to do syncing respectively. Sync clients known to work in combination include BitTorrent Sync, Dropbox, FolderSync, OwnCloud, NextCloud, Seafile, Syncthing, Syncopoli
46-
<br/>🔒 Can encrypt your textfiles with AES256. You need to set a password at the settings and use Android device with version Marshmallow or newer. You can use [jpencconverter](https://gitlab.com/opensource21/jpencconverter) to encrypt/decrypt easily on desktop. Be aware that only the text is encrypted not pictures or attachments.
45+
<br/>🔃 Markor is an offline app. It works with sync apps, but they have to do syncing respectively.
46+
<br/>🔒 Can encrypt your textfiles with AES256. You need to set a password at the settings and use Android device with version Marshmallow or newer. You can use [jpencconverter](https://gitlab.com/opensource21/jpencconverter) to encrypt/decrypt on desktop. Be aware that only the text is encrypted not pictures or attachments.
47+
48+
49+
50+
### Navigation
51+
* [**README**](README.md)
52+
* [Features](README.md#features)
53+
* [Contribute](README.md#contribute)
54+
* [Develop](README.md#develop)
55+
* [Privacy](README.md#privacy)
56+
* [License](README.md#license)
57+
* [**FAQ**](README.md#FAQ)
58+
* [File browser, file management](README.md#file-browser--file-management)
59+
* [Format: Markdown](README.md#format-markdown)
60+
* [Format: Markdown](README.md#format-markdown)
61+
* [Format: todo.txt](README.md#format-todotxt)
62+
* [**More**](doc)
63+
* [Synced plaintext TODO and notes - Vim / Vimwiki, Markor Android, Syncthing, GTD (Pitt)](doc/2020-09-26-vimwiki-sync-plaintext-to-do-and-notes-todotxt-markdown.md)
64+
* [Markor: How to synchronize files with Syncthing (wmww,tengucrow)](doc/2020-04-04-syncthing-file-sync-setup-how-to-use-with-markor.md)
65+
* [Using Markor to Write (and More) on an Android Device (The Plain Text Project)](doc/2019-07-16-using-markor-to-write-on-an-android-device-plaintextproject.md)
66+
* [How I Take Notes With Vim, Markdown, and Pandoc (Vaughan)](doc/2018-05-15-pandoc-vim-markdown-how-i-take-notes-vaughan.md)
67+
* [**NEWS**](NEWS.md)
68+
* [Markor v2.10 - Custom file templates, Share Into automatically remove URL tracking parameters](NEWS.md#markor-v210---custom-file-templates-share-into-automatically-remove-url-tracking-parameters)
69+
* [Markor v2.9 - Snippets, Templates, Graphs, Charts, Diagrams, YAML front-matter, Chemistry](NEWS.md#markor-v29---snippets-templates-graphs-charts-diagrams-yaml-front-matter-chemistry)
70+
* [Markor v2.8 - Multi-selection for todo.txt dialogs](NEWS.md#markor-v28---multi-selection-for-todotxt-dialogs)
71+
* [Markor v2.7 - Search in content, Backup & Restore settings](NEWS.md#markor-v27---search-in-content-backup--restore-settings)
72+
* [Markor v2.6 - Zim Wiki, Newline = New Paragraph, Save Format](NEWS.md#markor-v26---zim-wiki-newline--new-paragraph-save-format)
73+
* [Markor v2.5 - Zim Wiki - Search & Replace - Zettelkasten](NEWS.md#markor-v25---zim-wiki---search--replace---zettelkasten)
74+
* [Markor v2.4 - All new todo.txt - Programming language syntax highlighting](NEWS.md#markor-v24---all-new-todotxt---programming-language-syntax-highlighting)
75+
* [Markor v2.3 - Table of Contents, Custom Action Order](NEWS.md#markor-v23---table-of-contents-custom-action-order)
76+
* [Markor v2.2 - Presentations, Voice notes, Markdown table editor](NEWS.md#markor-v22---presentations-voice-notes-markdown-table-editor)
77+
* [Markor v2.1 - Key-Value highlighting (json/ini/yaml/csv), improved performance](NEWS.md#markor-v21---key-value-highlighting-jsoniniyamlcsv-improved-performance)
78+
* [Markor v2.0 - Search, dotFiles, PDF export](NEWS.md#markor-v20---search-dotfiles-pdf-export)
79+
* [Markor v1.8 - All new file browser, favourites and faster Markdown preview](NEWS.md#markor-v18---all-new-file-browser-favourites-and-faster-markdown-preview)
80+
* [Markor v1.7 - Custom Fonts, LinkBox with Markdown](NEWS.md#markor-v17---custom-fonts-linkbox-with-markdown)
81+
* [Markor v1.6 - DateTime dialog - Jekyll and KaTex improvements](NEWS.md#markor-v16---datetime-dialog---jekyll-and-katex-improvements)
82+
* [Markor v1.5 - Multiple windows, Markdown tasks, theming](NEWS.md#markor-v15---multiple-windows-markdown-tasks-theming)
83+
* [Markor v1.2 - Markdown with KaTex/Math - Search in current document](NEWS.md#markor-v12---markdown-with-katexmath---search-in-current-document)
84+
* [Markor v1.1 - Markdown picture import from gallery and camera](NEWS.md#markor-v11---markdown-picture-import-from-gallery-and-camera)
85+
* [Markor v1.0 - Widget shortcuts to LinkBox, ToDo, QuickNote](NEWS.md#markor-v10---widget-shortcuts-to-linkbox-todo-quicknote)
86+
* [Markor v0.3 - Faster loading, LinkBox added, Open link in browser TextAction](NEWS.md#markor-v03---faster-loading-linkbox-added-open-link-in-browser-textaction)
87+
4788

4889

4990
## Contribute
@@ -131,7 +172,7 @@ Browse to the start folder of your SD Card and press the + button (using file br
131172
#### How to synchronize files?
132173
Markor is and will stay an offline focused application. It works with sync synchronization apps, they have to do syncing respectively.
133174
Sync clients known to work in combination include BitTorrent Sync, Dropbox, FolderSync, OwnCloud, NextCloud, Seafile, Syncthing, Syncopoli and others.
134-
The project recommendation is Syncthing. [-> Guide for Syncthing](doc/markor-how-to-use-syncthing-for-sync.md)
175+
The project recommendation is Syncthing. [-> Guide for Syncthing](doc/2020-04-04-syncthing-file-sync-setup-how-to-use-with-markor.md)
135176

136177
#### What is Notebook?
137178
The root folder of your files! Markor starts with this folder at the main screen and allows you to browse files. You can work at any (accessible) file & location with Markor.

0 commit comments

Comments
 (0)