From 5ec5517778cba7bb40dcde0619b110f1a382d0cd Mon Sep 17 00:00:00 2001 From: Abdullah Atta Date: Fri, 3 Feb 2023 17:03:38 +0500 Subject: [PATCH] docs: reorder docs using the `index` frontmatter property --- docs/help/contents/README.md | 2 +- .../backup-and-restore-notes-in-notesnook.md | 1 + docs/help/contents/creating-note.md | 1 + docs/help/contents/encryption.md | 1 + .../contents/export-notes-from-notesnook.md | 7 ++++- docs/help/contents/importing-notes/README.md | 7 +++-- .../{download-install.md => installation.md} | 1 + .../contents/lock-notes-with-private-vault.md | 1 + .../contents/note-sharing-with-monographs.md | 1 + docs/help/contents/organization/README.md | 1 + .../how-do-i-add-shortcuts-to-side-menu.md | 1 + .../how-do-i-add-tags-to-notes.md | 1 + .../how-do-i-organize-notes-using-colors.md | 1 + ...how-do-i-organize-notes-using-favorites.md | 1 + .../how-do-i-pin-notes-and-notebooks.md | 1 + .../how-to-organize-notes-with-notebooks.md | 1 + docs/help/contents/versionhistory.md | 1 + docs/help/docgen.yaml | 29 ++++--------------- 18 files changed, 31 insertions(+), 28 deletions(-) rename docs/help/contents/{download-install.md => installation.md} (99%) diff --git a/docs/help/contents/README.md b/docs/help/contents/README.md index d2be3bf6f..c8199b790 100644 --- a/docs/help/contents/README.md +++ b/docs/help/contents/README.md @@ -6,4 +6,4 @@ Notesnook is our **proof** that privacy does _not_ (always) have to come at the And with that convenience in mind, we believe that it is equally important to put together a simple & useful help website about everything Notesnook. Our help is a complete walkthrough of the Notesnook app and it's features. -So let's get started with [installing Notesnook](/download-install) on all your devices. \ No newline at end of file +So let's get started with [installing Notesnook](/installation) on all your devices. diff --git a/docs/help/contents/backup-and-restore-notes-in-notesnook.md b/docs/help/contents/backup-and-restore-notes-in-notesnook.md index d8ad5c096..c10b26663 100644 --- a/docs/help/contents/backup-and-restore-notes-in-notesnook.md +++ b/docs/help/contents/backup-and-restore-notes-in-notesnook.md @@ -1,5 +1,6 @@ --- title: Backup and restore +index: 5 --- # How to Backup your notes diff --git a/docs/help/contents/creating-note.md b/docs/help/contents/creating-note.md index a7fe07a99..a46322225 100644 --- a/docs/help/contents/creating-note.md +++ b/docs/help/contents/creating-note.md @@ -1,5 +1,6 @@ --- title: Creating a note +index: 1 --- # Creating a note diff --git a/docs/help/contents/encryption.md b/docs/help/contents/encryption.md index cca119a68..61d363f3c 100644 --- a/docs/help/contents/encryption.md +++ b/docs/help/contents/encryption.md @@ -1,5 +1,6 @@ --- title: How is my data encrypted +index: 2 --- # How is my data encrypted diff --git a/docs/help/contents/export-notes-from-notesnook.md b/docs/help/contents/export-notes-from-notesnook.md index 909cde40f..b4e2fe3ae 100644 --- a/docs/help/contents/export-notes-from-notesnook.md +++ b/docs/help/contents/export-notes-from-notesnook.md @@ -1,5 +1,6 @@ --- title: Exporting notes +index: 6 --- # How do I export notes from Notesnook? @@ -7,15 +8,19 @@ title: Exporting notes You can export your notes as PDF, HTML, Markdown and Plain text files on desktop and mobile apps. # [Desktop/Web](#/tab/web) + 1. Right click on a note to open `Note properties` 2. Click on 'Export' 3. Select the desired format to export in 4. Wait a few moments while your note is exported 5. Save the note in desired location + # [Mobile](#/tab/mobile) + 1. Press the `three-dot more` button on a note to open `Note properties` sheet 2. Press on 'Export' 3. Select the desired format to export in 4. Wait a few moments while your note is exported 5. Exported notes are stored in `Notesnook/exported` folder. ---- \ No newline at end of file + +--- diff --git a/docs/help/contents/importing-notes/README.md b/docs/help/contents/importing-notes/README.md index e544afef4..32a6b30d9 100644 --- a/docs/help/contents/importing-notes/README.md +++ b/docs/help/contents/importing-notes/README.md @@ -1,5 +1,6 @@ --- title: Notesnook importer +index: 4 --- # Import notes from any notes app @@ -20,10 +21,10 @@ You can try out the importer by going to [https://importer.notesnook.com](https: 6. Standard Notes 7. Simplenote 8. Google Keep -9. Bear notes app -10. Joplin notes app +9. Joplin +10. Zoho Notebook -**Don't see your notes app?** No worries, create an issue on [github](https://github.com/streetwriters/notesnook/issues) +**Don't see your notes app?** No worries, create an issue on [Github](https://github.com/streetwriters/notesnook/issues) ## Is it safe to import? diff --git a/docs/help/contents/download-install.md b/docs/help/contents/installation.md similarity index 99% rename from docs/help/contents/download-install.md rename to docs/help/contents/installation.md index 49a95c302..c89b456b4 100644 --- a/docs/help/contents/download-install.md +++ b/docs/help/contents/installation.md @@ -1,5 +1,6 @@ --- title: Installation +index: 0 --- # Installation diff --git a/docs/help/contents/lock-notes-with-private-vault.md b/docs/help/contents/lock-notes-with-private-vault.md index ebcaaf2bb..6b1c48f6a 100644 --- a/docs/help/contents/lock-notes-with-private-vault.md +++ b/docs/help/contents/lock-notes-with-private-vault.md @@ -1,5 +1,6 @@ --- title: Locking notes +index: 7 --- # How do I lock notes with private vault? diff --git a/docs/help/contents/note-sharing-with-monographs.md b/docs/help/contents/note-sharing-with-monographs.md index 96e661290..2ef957d50 100644 --- a/docs/help/contents/note-sharing-with-monographs.md +++ b/docs/help/contents/note-sharing-with-monographs.md @@ -1,5 +1,6 @@ --- title: Monographs +index: 8 --- # Monographs diff --git a/docs/help/contents/organization/README.md b/docs/help/contents/organization/README.md index 927c241ea..0a983cab9 100644 --- a/docs/help/contents/organization/README.md +++ b/docs/help/contents/organization/README.md @@ -1,5 +1,6 @@ --- title: Organization +index: 3 --- # Organization diff --git a/docs/help/contents/organization/how-do-i-add-shortcuts-to-side-menu.md b/docs/help/contents/organization/how-do-i-add-shortcuts-to-side-menu.md index 8abc71fe6..4d84758dc 100644 --- a/docs/help/contents/organization/how-do-i-add-shortcuts-to-side-menu.md +++ b/docs/help/contents/organization/how-do-i-add-shortcuts-to-side-menu.md @@ -1,5 +1,6 @@ --- title: Shortcuts +index: 6 --- # Add shortcuts to side menu diff --git a/docs/help/contents/organization/how-do-i-add-tags-to-notes.md b/docs/help/contents/organization/how-do-i-add-tags-to-notes.md index d6c72059c..54ea6d976 100644 --- a/docs/help/contents/organization/how-do-i-add-tags-to-notes.md +++ b/docs/help/contents/organization/how-do-i-add-tags-to-notes.md @@ -1,5 +1,6 @@ --- title: Tags +index: 1 --- # Tags diff --git a/docs/help/contents/organization/how-do-i-organize-notes-using-colors.md b/docs/help/contents/organization/how-do-i-organize-notes-using-colors.md index 5306faf01..88791e2ad 100644 --- a/docs/help/contents/organization/how-do-i-organize-notes-using-colors.md +++ b/docs/help/contents/organization/how-do-i-organize-notes-using-colors.md @@ -1,5 +1,6 @@ --- title: Colors +index: 3 --- # Organize notes with colors diff --git a/docs/help/contents/organization/how-do-i-organize-notes-using-favorites.md b/docs/help/contents/organization/how-do-i-organize-notes-using-favorites.md index e1a54e39c..374f83e99 100644 --- a/docs/help/contents/organization/how-do-i-organize-notes-using-favorites.md +++ b/docs/help/contents/organization/how-do-i-organize-notes-using-favorites.md @@ -1,5 +1,6 @@ --- title: Favorites +index: 4 --- # Add notes to favorites diff --git a/docs/help/contents/organization/how-do-i-pin-notes-and-notebooks.md b/docs/help/contents/organization/how-do-i-pin-notes-and-notebooks.md index 1edcecf38..c73577c92 100644 --- a/docs/help/contents/organization/how-do-i-pin-notes-and-notebooks.md +++ b/docs/help/contents/organization/how-do-i-pin-notes-and-notebooks.md @@ -1,5 +1,6 @@ --- title: Pins +index: 5 --- # Pin notes and notebooks diff --git a/docs/help/contents/organization/how-to-organize-notes-with-notebooks.md b/docs/help/contents/organization/how-to-organize-notes-with-notebooks.md index a3023e7ba..a90ae0407 100644 --- a/docs/help/contents/organization/how-to-organize-notes-with-notebooks.md +++ b/docs/help/contents/organization/how-to-organize-notes-with-notebooks.md @@ -1,5 +1,6 @@ --- title: Notebooks +index: 0 --- # Organizing notes with notebooks diff --git a/docs/help/contents/versionhistory.md b/docs/help/contents/versionhistory.md index 7aaa1bce2..7e4f5c38a 100644 --- a/docs/help/contents/versionhistory.md +++ b/docs/help/contents/versionhistory.md @@ -1,5 +1,6 @@ --- title: Version History +index: 9 --- # Version history diff --git a/docs/help/docgen.yaml b/docs/help/docgen.yaml index cf1d1efef..fa4fe430d 100644 --- a/docs/help/docgen.yaml +++ b/docs/help/docgen.yaml @@ -1,25 +1,8 @@ --- -title: "Notesnook" -docs_dir: "./contents" +title: Notesnook +subtitle: HELP +docs_dir: ./contents logo: logo.png -colors: - main: "#008837" -navigation: - - path: contents/download-install.md - - path: contents/creating-note.md - - path: contents/encryption.md - - path: contents/organization - children: - - path: contents/organization/how-to-organize-notes-with-notebooks.md - - path: contents/organization/how-do-i-add-tags-to-notes.md - - path: contents/organization/how-do-i-organize-notes-using-colors.md - - path: contents/organization/how-do-i-organize-notes-using-favorites.md - - path: contents/organization/how-do-i-pin-notes-and-notebooks.md - - path: contents/organization/how-do-i-add-shortcuts-to-side-menu.md - - path: contents/importing-notes - children: "*" - - path: contents/backup-and-restore-notes-in-notesnook.md - - path: contents/export-notes-from-notesnook.md - - path: contents/lock-notes-with-private-vault.md - - path: contents/note-sharing-with-monographs.md - - path: contents/versionhistory.md + +footer: + copyright: Copyright © 2023 Streetwriters (Private) Limited