Mirrors/super-productivity
1
0
Fork 0
mirror of https://github.com/johannesjo/super-productivity.git synced 2026-08-04 05:22:39 +00:00
Code Issues Projects Releases Wiki Activity

docs/fix broken links (#6158)

Browse source 
* docs(wiki): update use of aliases

* docs(wiki): fix broken links from aliases

Removed aliases from Wiki-style links, exclamation marks for image embedding, and recombine the Installation instructions.
This is also a test of the new permissions for the GitHub Action.
This commit is contained in:
Corey Newton 2026-01-25 01:08:09 -08:00 • committed by GitHub
parent 1b32a81f76
commit c5f99f3bf8
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
12 changed files with 161 additions and 127 deletions
Download patch file Download diff file Expand all files Collapse all files

4
docs/wiki/0.01-Style-Guide.md
View file

@ -34,6 +34,10 @@ Nested Image: `[[images/image.png]]`
As mentioned above, nesting the images cuts down on clutter so that is preferred.
### Aliases
Links such as `[[9.Test-Note|Test Note]]` will result in a path be rendered as a URL such as `../wiki/Test-Note` and will not resolve to anything. Do not use this syntax.
## Linting
There is a GitHub Action to lint all markdown with `pymarkdownlnt`. If able, invoke `pymarkdownlnt --disable-rules line-length scan --recurse ./docs/wiki` on all files before submitting a PR. On Arch it requires only `pipx install pymarkdownlnt`. Ideally, configure as a pre-commit hook to ensure every commit will pass CI.

2
docs/wiki/1.00-Quickstarts.md
View file

@ -6,7 +6,7 @@
### [[1.01-First-Steps]]
Check out _Super Productivity 101_ a.k.a. [[1.01-First-Steps|First Steps]] where we will teach you:
Check out _Super Productivity 101_ a.k.a. [[1.01-First-Steps]] where we will teach you:
- how to use Super Productivity in the web app.
- how to install the desktop or mobile app.

26
docs/wiki/1.01a-First-Steps_Quick-Tour.md
View file

@ -6,53 +6,53 @@ Open the [Web App](https://app.super-productivity.com/). This doesn't contain al
There is an interactive tour that will greet you at first. These notes follow this tour closely.
![[assets/1.01-First-Steps-welcome.png]]
[[assets/1.01-First-Steps-welcome.png]]
Use the "+" button in the top right or the keyboard shortcut `Shift+A` to do so.
![[assets/1.01-First-Steps-create-task.png]]
[[assets/1.01-First-Steps-create-task.png]]
Add as many tasks as desired. There is a short-hand syntax available that is similar to many other task managers. Press 'Escape' or click outside the task overlay when done.
![[assets/1.01-First-Steps-finish-task-creation.png]]
[[assets/1.01-First-Steps-finish-task-creation.png]]
_Super Productivity_ integrates time tracking as a core feature. It is easy to remove or add time usage later if the idea of a running stopwatch adds too much pressure. Starting and stopping can be done at anytime no matter where you are in the app.
![[assets/1.01-First-Steps-start-time-tracking.png]]
[[assets/1.01-First-Steps-start-time-tracking.png]]
![[assets/1.01-First-Steps-pause-time-tracking.png]]
[[assets/1.01-First-Steps-pause-time-tracking.png]]
For any task in the list, you can open a side panel to edit details any details associated with it.
![[assets/1.01-First-Steps-task-details.png]]
[[assets/1.01-First-Steps-task-details.png]]
![[assets/1.01-First-Steps-task-details-1.png]]
[[assets/1.01-First-Steps-task-details-1.png]]
To delete a task, right click on it to open it up and the "Delete Task" button will be at the bottom. 'Backspace' will accomplish the same thing if the task is selected.
![[assets/1.01-First-Steps-delete-task.png]]
[[assets/1.01-First-Steps-delete-task.png]]
Continue with the Quick Tour to see the other areas such as Projects and Issues. Open up Settings.
![[assets/1.01-First-Steps-settings-sync-1.png]]
[[assets/1.01-First-Steps-settings-sync-1.png]]
The Web App is limited to your browser on a single computer at first. Later on if you find that Super Productivity works well for you it is very likely you will want to configure "Syncing". Even if you only use a single computer, using "Sync" will ensure that all your data is saved reliably. We can ignore "Sync Settings" for now.
![[assets/1.01-First-Steps-settings-sync-2.png]]
[[assets/1.01-First-Steps-settings-sync-2.png]]
---
The Quick Tour doesn't cover this next part but it will eventually come up. On the main "Today" view that we have been looking at there is a "Finish Day" button:
![[assets/1.01-First-Steps-finish-day-0.png]]
[[assets/1.01-First-Steps-finish-day-0.png]]
This will move your completed tasks to the "Archive" and present you with an End-of-Day report for you to review. The first section sums your time tracked compared to your time estimates.
![[assets/1.01-First-Steps-finish-day-1.png]]
[[assets/1.01-First-Steps-finish-day-1.png]]
The second section is entirely subjective and help track trends of how you feel while working.
![[assets/1.01-First-Steps-finish-day-2.png]]
[[assets/1.01-First-Steps-finish-day-2.png]]
---

2
docs/wiki/1.01b-First-Steps_Download-and-Install.md
View file

@ -6,7 +6,7 @@ See [[1.01a-First-Steps_Quick-Tour]] for the intro that precedes this.
## Download and Install
[[1.01b-First-Steps_Download-and-Install]]
[[2.01-Downloads and Install]]
Include additional guidance here as needed. It's possible to just use the Web app version too.

2
docs/wiki/1.01c-First-Steps_Additional-Resources.md
View file

@ -4,7 +4,7 @@ If you make any errors, you can restore your data from backups. Refer to [[2.02-
!TODO: Describe some of these in more detail:
![[assets/1.01c-First-Steps_Additional-Resources-app-help.png]]
[[assets/1.01c-First-Steps_Additional-Resources-app-help.png]]
[[1.02-Configure-Data-Synchronization]]

19
docs/wiki/2.00-How_To.md
View file

@ -4,30 +4,25 @@ See [[0.00-Wiki-Structure-and-Organization#How to Write a `How To`]] if you are
## Setup and Configuration
### 2.01-Download-and-Install
[[2.01-Downloads and Install]]
- [[2.01a-Download-and-Install_Windows|Windows]]
- [[2.01b-Download-and-Install_Linux|Linux]]
- [[2.01c-Download-and-Install_MacOS|MacOS]]
- [[2.01d-Download-and-Install_Android|Android]]
For all platforms, you can always install [[../../releases]] if you prefer.
For all platforms, you can always install [[../../releases|from the releases page]] if you prefer.
### [[2.02-Restore-Data-From-Backup]]
[[2.02-Restore-Data-From-Backup]]
### Adjust Common Settings (?)
## Tasks
### [[2.03-Add-Tasks]]
[[2.03-Add-Tasks]]
Include all the actions that branch out from this such as subtasks, scheduling, repetition, and integrations via [[4.00-Concepts#Integrations-with-Other-Apps]].
### [[2.04-Manage-Subtasks]]
[[2.04-Manage-Subtasks]]
### [[2.05-Manage-Scheduled-Tasks]]
[[2.05-Manage-Scheduled-Tasks]]
### [[2.06-Manage-Repeating-Tasks]]
[[2.06-Manage-Repeating-Tasks]]
## Guides To Be Written

127
docs/wiki/2.01-Downloads and Install.md Normal file
View file

@ -0,0 +1,127 @@
# 2.01-Downloads And Install
## All Platforms
[Install from the releases page](https://github.com/super-productivity/super-productivity/releases).
## Windows
Due to certification issues it's recommended to download the app from the Microsoft Store:
<a href='//www.microsoft.com/store/apps/9nhfvg8361tw?cid=storebadge&ocid=badge'><img src='https://developer.microsoft.com/store/badges/images/English_get-it-from-MS.png' alt='English badge' width="127" height="52"/></a>
You can also install the app using [Chocolatey](https://community.chocolatey.org/packages/super-productivity):
```powershell
choco install super-productivity
```
or using [Scoop](https://scoop.sh/#/apps?q=super-productivity&id=26ccca2d7edd51629727a9468c4136ea89a652a0):
```powershell
scoop install extras/super-productivity
```
## Linux
### Snap - Most Distributions
Install via command-line:
```bash
# stable
sudo snap install superproductivity
# edge channel releases
sudo snap install --channel=edge superproductivity
# it is also recommended to disable updates to the app while it is running:
sudo snap set core experimental.refresh-app-awareness=true
```
**Important: Enable Local File Sync**
To use local file sync, you need to manually connect the `home` interface:
```bash
sudo snap connect superproductivity:home
```
**⚠️ Snap Data Persistence Warning**
When uninstalling the snap package, all user data (tasks, projects, settings) stored in `~/snap/superproductivity/common/` may be removed. Always export your data before uninstalling. Consider using Flatpak, AppImage, or .deb packages if you prefer data to persist in the standard `~/.config/` location.
For more details, see [issue #6031](https://github.com/super-productivity/super-productivity/issues/6031).
<a href="https://snapcraft.io/superproductivity">
<img alt="Get it from the Snap Store" src="https://snapcraft.io/static/images/badges/en/snap-store-black.svg" />
</a>
### Flatpak - Most Distributions
Must install Flatpak first. See [setup instructions for all distributions](https://flathub.org/setup).
Install via command-line:
```bash
# install
flatpak install flathub com.super_productivity.SuperProductivity
# run
flatpak run com.super_productivity.SuperProductivity
```
<a href='https://flathub.org/apps/com.super_productivity.SuperProductivity'>
<img width='175' alt='Get it on Flathub' src='https://flathub.org/api/badge?locale=en'/>
</a>
### Aur - Arch Linux
```bash
git clone https://aur.archlinux.org/superproductivity-bin.git
cd superproductivity-bin
makepkg -si
```
### AppImage
If you encounter problems, please have a look here:
<https://github.com/super-productivity/super-productivity/issues/3193#issuecomment-2131315513>
## MacOS
Install via [homebrew cask](https://github.com/caskroom/homebrew-cask):
```bash
brew install --cask superproductivity
```
<a href='//apps.apple.com/app/super-productivity/id1482572463?l=en&mt=12' target="_blank">
<img src='../screens/app-store-badge.svg'
alt='App Store Badge'
height="50" />
</a>
## Android
A new version of the Android app is now available with **Connectivity-Free Mode**, allowing you to use the app without an internet connection.
This update offers more flexibility, supporting both fully offline usage and integration with services like WebDAV and Dropbox for syncing. Enjoy a smoother, more reliable experience whether you're online or offline.
Stay tuned for even more exciting updates!
You can find the Android app here:
<a href='//play.google.com/store/apps/details?id=com.superproductivity.superproductivity' target="_blank">
<img src='https://github.com/super-productivity/super-productivity/blob/master/docs/screens/google-play-badge.png'
align="center"
alt='App Store Badge'
height="50" />
</a>
<a href='//f-droid.org/en/packages/com.superproductivity.superproductivity' target="_blank">
<img src='https://f-droid.org/assets/fdroid-logo-text_S0MUfk_FsnAYL7n2MQye-34IoSNm6QM6xYjDnMqkufo=.svg'
align="center"
alt='F-Droid Badge'
height="50" />
</a>
The sources can be [found here](https://github.com/super-productivity/super-productivity/tree/master/android)

11
docs/wiki/2.01a-Download-and-Install_Windows.md
View file

@ -1,11 +0,0 @@
# A Download And Install Windows
Due to certification issues it's recommended to download the app from the Microsoft Store:
[![Get it from Microsoft Store](https://developer.microsoft.com/store/badges/images/English_get-it-from-MS.png)](https://www.microsoft.com/store/apps/9nhfvg8361tw?cid=storebadge&ocid=badge)
You can also install the app using [Chocolatey](https://community.chocolatey.org/packages/super-productivity):
```powershell
choco install super-productivity
```

55
docs/wiki/2.01b-Download-and-Install_Linux.md
View file

@ -1,55 +0,0 @@
# B Download And Install Linux
## Snap - Most Distributions
Install via command-line:
```bash
## stable
sudo snap install superproductivity
## edge channel releases
sudo snap install --channel=edge superproductivity
## it is also recommended to disable updates to the app while it is running:
sudo snap set core experimental.refresh-app-awareness=true
```
[![Get it from the Snap Store](https://snapcraft.io/static/images/badges/en/snap-store-black.svg)](https://snapcraft.io/superproductivity)
### Flatpak - Most Distributions
Must install Flatpak first. See [setup instructions for all distributions](https://flathub.org/setup).
Install via command-line:
```bash
## install
flatpak install flathub com.super_productivity.SuperProductivity
## run
flatpak run com.super_productivity.SuperProductivity
```
[![Get it on Flathub](https://flathub.org/api/badge?locale=en)](https://flathub.org/apps/com.super_productivity.SuperProductivity)
### Aur - Arch Linux
```bash
git clone <https://aur.archlinux.org/superproductivity-bin.git>
cd superproductivity-bin
makepkg -si
```
#### AppImage
If you encounter problems, please have a look here:
<https://github.com/super-productivity/super-productivity/issues/3193#issuecomment-2131315513>

11
docs/wiki/2.01c-Download-and-Install_MacOS.md
View file

@ -1,11 +0,0 @@
# C Download And Install Macos
## MacOS
Install via [homebrew cask](https://github.com/caskroom/homebrew-cask):
```bash
brew install --cask superproductivity
```
[[../screens/app-store-badge.svg]]

15
docs/wiki/2.01d-Download-and-Install_Android.md
View file

@ -1,15 +0,0 @@
# D Download And Install Android
A new version of the Android app is now available with **Connectivity-Free Mode**, allowing you to use the app without an internet connection.
This update offers more flexibility, supporting both fully offline usage and integration with services like WebDAV and Dropbox for syncing. Enjoy a smoother, more reliable experience whether you're online or offline.
Stay tuned for even more exciting updates!
You can find the Android app here:
[![Google Play Badge](../screens/google-play-badge.png)](https://play.google.com/store/apps/details?id=com.superproductivity.superproductivity)
[![F-Droid Badge](https://f-droid.org/assets/fdroid-logo-text_S0MUfk_FsnAYL7n2MQye-34IoSNm6QM6xYjDnMqkufo=.svg)](https://f-droid.org/en/packages/com.superproductivity.superproductivity)
The sources can be [[../../android|found here]].

14
docs/wiki/_Sidebar.md
View file

@ -1,20 +1,20 @@
# Table of Contents
## [[1.00-Quickstarts|Quickstarts]]
## [[1.00-Quickstarts]]
- [[1.01-First-Steps|New Users? Start Here!]]
- [[1.01-First-Steps]]
## [[2.00-How_To|How-To Guides]]
## [[2.00-How_To]]
- [[2.00-How_To#2.01-Download-and-Install|Download and Install (All Platforms)]]
- [[2.02-Restore-Data-From-Backup|Restore Data from Backup]]
- [[2.01-Downloads and Install]]
- [[2.02-Restore-Data-From-Backup]]
## [[3.00-Reference|Reference]]
## [[3.00-Reference]]
- [[3.02-Settings-and-Preferences]]
- [[3.03-Keyboard-Shortcuts]]
- [[3.04-Short-Syntax]]
## [[4.00-Concepts|Concepts]]
## [[4.00-Concepts]]
- [[4.01-Tags]]