Skip to content

Commit c2610d4

Browse files
committed
Update documentation
1 parent f813481 commit c2610d4

File tree

20 files changed

+1636
-1340
lines changed

20 files changed

+1636
-1340
lines changed

documentation/docs/contributing.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
---
2+
title: 🤝🏼 Contributing
23
sidebar_position: 10
34
---
45

documentation/docs/faq.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
2-
sidebar_position: 7
2+
title: ❓ FAQ
3+
sidebar_position: 9
34
---
45

56
# FAQ - Frequently Asked Questions
@@ -57,7 +58,7 @@ Yes, you can use the backup and restore feature to transfer your notes to a new
5758
### Can I sync my notes across multiple devices?
5859

5960
NotallyX doesn't include built-in sync functionality. However, you can use third-party cloud storage services to sync your backup files across devices.
60-
See [Settings](./features/settings.mdx#asd)
61+
See [Settings](settings.mdx#asd)
6162

6263
### Can I recover deleted notes?
6364

documentation/docs/features/_category_.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
{
22
"label": "Features",
33
"position": 3,
4+
"collapsible": false,
45
"link": {
56
"type": "generated-index",
67
"description": "Explore the features and capabilities of NotallyX."
Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
---
2+
title: 💾 Backups
3+
type: category
4+
description: How to securely backup your data
5+
sidebar_position: 6
6+
---
7+
8+
# Backups
9+
10+
NotallyX provides several features to help backing up your data.
11+
12+
13+
### Auto-Backup
14+
NotallyX can automatically back up your notes to prevent data loss.
15+
16+
1. Open the app settings
17+
2. Navigate to "Auto Backups"
18+
3. Tap "Backups Folder" and "Choose folder" to select a folder for backups
19+
4. After you've set your backups folder you can:
20+
- Enable auto backups whenever a note changed ("Backup on exit Note automatically")
21+
- Enable periodic backups
22+
- Configure the amount of previous backups to keep
23+
24+
### Manual Backup
25+
26+
You can also create backups manually:
27+
28+
1. Open the app settings
29+
2. Navigate to "Backup"
30+
3. Tap "Export backup"
31+
4. Choose a location and name for the backup
32+
5. Tap "Save"
33+
34+
### Using Cloud-Storage/WebDAV
35+
36+
#### SAF Mounts
37+
If you wish to store your backups on a Cloud-Storage/WebDAV, you need to use a third-party app to mount your Cloud-Storage/WebDAV on your device, so that the SAF (Storage Access Framework) can access it.
38+
For generic WebDAV servers you can use apps like [DAVx⁵](https://f-droid.org/en/packages/at.bitfire.davdroid/), [RS File Explorer](https://play.google.com/store/search?q=rs+file+explorer&c=apps&hl=en) or similar,
39+
as long as they are able to mount your WebDAV server into your android system.
40+
E.g. for [DAVx⁵](https://f-droid.org/en/packages/at.bitfire.davdroid/):
41+
1. Open DAVx⁵ -> Menu -> `WebDAV mounts` -> `+`
42+
2. Enter `URL`, `Display Name`, `Username`, `Password` of your WebDAV Server -> `Add mount`
43+
3. After adding your mount, you can go back into NotallyX and setup the backup folder, you will now see your WebDAV in the file chooser and can pick any folder on it:
44+
<img src={require('/img/webdav.png').default} width="32%" alt="WebDAV in File Chooser" />
45+
46+
#### Synchronization
47+
Instead of mounting your Cloud-Storage/WebDAV you can also use apps like [FolderSync](https://play.google.com/store/apps/details?id=dk.tacit.android.foldersync.lite&hl=en) to sync a folder on your device with other devices and simply set NotallyX's backup folder to that synched folder.
48+
49+
50+
### Restoring from Backup
51+
52+
If you need to restore your notes from a backup:
53+
54+
1. Open the app settings
55+
2. Navigate to "Backup"
56+
3. Tap "Import backup"
57+
4. Select the backup file you want to restore from
58+
5. If your backup is password protected, provide the correct password
59+
6. Tap "Import Backup"
60+
61+
Note: Importing a backup does not delete any existing notes/labels
62+
63+
## Related Features
64+
65+
- [Settings](../settings.mdx): Learn about ways to customize NotallyX

documentation/docs/features/labels-organization.mdx renamed to documentation/docs/features/labels.mdx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
---
2+
title: 🏷️ Labels
3+
description: Organize your notes with Labels
24
sidebar_position: 4
35
---
46

@@ -114,4 +116,4 @@ Pinning keeps important notes at the top of your list, regardless of the sort or
114116

115117
- [Rich Text Formatting](rich-text.mdx): Learn how to format text in your notes
116118
- [Task Lists and Subtasks](task-lists.mdx): Discover how to create and manage task lists
117-
- [Settings](settings.mdx): Learn about other ways to customize NotallyX
119+
- [Settings](../settings.mdx): Learn about other ways to customize NotallyX

documentation/docs/features/reminders.mdx

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
---
2-
sidebar_position: 8
2+
title: 🔔 Reminders
3+
description: Configure Reminders for your important notes
4+
sidebar_position: 5
35
---
46

57
# Reminders
@@ -28,4 +30,4 @@ To get an overview of all currently configured reminders:
2830
## Related Features
2931

3032
- [Rich Text Formatting](rich-text.mdx): Learn how to format text in your notes
31-
- [Labels and Organization](./labels-organization.mdx): Discover how to organize your notes effectively
33+
- [Labels and Organization](./labels.mdx): Discover how to organize your notes effectively

documentation/docs/features/rich-text.mdx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
---
2+
title: ✏️ Text Formatting
3+
description: Format your text notes with common formatting options
24
sidebar_position: 2
35
---
46

@@ -41,4 +43,4 @@ NotallyX provides undo and redo functionality to help you recover from mistakes
4143
## Related Features
4244

4345
- [Task Lists and Subtasks](./task-lists.mdx): Learn how to create and manage task lists
44-
- [Labels and Organization](./labels-organization.mdx): Discover how to organize your notes effectively
46+
- [Labels and Organization](./labels.mdx): Discover how to organize your notes effectively

documentation/docs/features/task-lists.mdx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
---
2+
title: 📋 Task Lists
3+
description: Organize your tasks with Task Lists
24
sidebar_position: 3
35
---
46

@@ -75,4 +77,4 @@ If you want to convert your task list into a regular text note:
7577
## Related Features
7678

7779
- [Rich Text Formatting](rich-text.mdx): Learn how to format text in your notes
78-
- [Labels and Organization](./labels-organization.mdx): Discover how to organize your notes effectively
80+
- [Labels and Organization](./labels.mdx): Discover how to organize your notes effectively

documentation/docs/get-started.md

Lines changed: 0 additions & 36 deletions
This file was deleted.
Lines changed: 42 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,39 @@
11
---
2+
title: 👋 Introduction
23
sidebar_position: 1
34
---
45

5-
# Features Overview
6+
# Introduction to NotallyX
7+
8+
Welcome to the official documentation for **NotallyX**, a minimalistic yet powerful note-taking app for Android.
9+
10+
![NotallyX Logo](/img/logo.png)
11+
12+
## What is NotallyX?
13+
14+
NotallyX is an open-source note-taking application designed to be simple, intuitive, and feature-rich. It's an extended version of the original Notally app, with additional features and improvements.
15+
16+
Whether you need to jot down quick thoughts, create detailed task lists, or organize your ideas with colors and labels, NotallyX provides all the tools you need without unnecessary complexity.
17+
18+
## Key Features
19+
20+
- **Rich Text Notes**: Create notes with support for bold, italics, mono space, and strike-through formatting
21+
- **Task Lists**: Organize your to-dos with subtasks and automatic sorting of completed items
22+
- **Reminders**: Set notifications for important notes
23+
- **File Attachments**: Add pictures, PDFs, and other files to your notes
24+
- **Organization Tools**: Sort, color, pin, and label your notes for quick access
25+
- **Security**: Lock your notes with biometric authentication or PIN
26+
- **Backup**: Configure automatic backups to keep your notes safe
27+
- **Widgets**: Access important notes directly from your home screen
28+
- **Audio Notes**: Create quick audio recordings
29+
- **Customization**: Extensive preferences to adjust the app to your liking
30+
31+
## Getting Started
32+
33+
Ready to start using NotallyX? Check out our [Quick Start Guide](quick-start.md) to learn the basics.
34+
35+
36+
## Features Overview
637

738
NotallyX offers a wide range of features to help you capture, organize, and access your notes efficiently. This page provides an overview of the main features available in the app.
839

@@ -13,19 +44,14 @@ Create rich text notes with formatting options:
1344
- **Bold**, *italic*, ~~strikethrough~~, and `monospace` text
1445
- Clickable links for websites, phone numbers, and email addresses
1546
- Undo/redo functionality
16-
- File attachments (images, PDFs, etc.)
47+
- File attachments (images, record audios, PDFs, etc.)
1748

1849
### List Notes
1950
Create structured to-do lists and checklists:
2051
- Checkboxes for marking items as complete
2152
- Hierarchical organization with subtasks
2253
- Automatic sorting of completed items
2354

24-
### Audio Notes
25-
Record and save audio notes:
26-
- Quick voice recording
27-
- Playback controls
28-
- Add text notes to accompany audio
2955

3056
## Organization Features
3157

@@ -115,9 +141,13 @@ Never forget important information:
115141
## Feature Details
116142

117143
For more detailed information about specific features, check out the following pages:
118-
- ✏️ [Rich Text Formatting](rich-text.mdx)
119-
- [Task Lists and Subtasks](task-lists.mdx)
120-
- 🏷️ [Labels and Organization](labels-organization.mdx)
121-
- 🔒 [Security and Privacy](security-privacy.mdx)
144+
- ✏️ [Rich Text Formatting](features/rich-text.mdx)
145+
- 📋 [Task Lists and Subtasks](features/task-lists.mdx)
146+
- 🏷️ [Labels and Organization](features/labels.mdx)
147+
- 🛡️ [Security and Privacy](security-privacy.mdx)
122148
- ⚙️ [Settings](settings.mdx)
123-
- 🔔 [Reminders](reminders.mdx)
149+
- 🔔 [Reminders](features/reminders.mdx)
150+
151+
## Contributing
152+
153+
NotallyX is an open-source project, and contributions are welcome! Check out our [Contribution Guidelines](contributing.md) to learn how you can help improve the app.

0 commit comments

Comments
 (0)