Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .codespellrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
[codespell]
# Ref: https://github.com/codespell-project/codespell#using-a-config-file
skip = .git,.gitignore,.gitattributes,*.svg,package-lock.json,*.css,.codespellrc
check-hidden = true
# ignore-regex =
# ignore-words-list =
23 changes: 23 additions & 0 deletions .github/workflows/codespell.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Codespell configuration is within .codespellrc
---
name: Codespell

on:
push:
branches: [main]
pull_request:
branches: [main]

permissions:
contents: read

jobs:
codespell:
name: Check for spelling errors
runs-on: ubuntu-latest

steps:
- name: Checkout
uses: actions/checkout@v6
- name: Codespell
uses: codespell-project/actions-codespell@8f01853be192eb0f849a5c7d721450e7a467c579 # v2.2
2 changes: 1 addition & 1 deletion docs/getting-started/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ This guide provides instructions on how to quickly get started with Donetick loc

Before running Donetick, ensure you have a valid configuration file. Donetick looks for a YAML file named `local.yaml` or `selfhosted.yaml` within the `./config` directory. The file name is chosen based on the `DT_ENV` environment variable. If `DT_ENV` is not set, `local.yaml` is used by default.

1. **Create a Configuration File:** If you don't have one, create a YAML file (e.g., `selfhosted.yaml`) based on the example provided in the [Configuration](./configration) documentation.
1. **Create a Configuration File:** If you don't have one, create a YAML file (e.g., `selfhosted.yaml`) based on the example provided in the [Configuration](./configuration) documentation.
2. **Place the Configuration File:** Place the `selfhosted.yaml` (or your chosen name) file in the `/config` directory within your Donetick application's root directory.

## Running Donetick
Expand Down
2 changes: 1 addition & 1 deletion docs/notifications/pushover.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ To receive notifications on your devices, you need to get your Pushover user key

## Configure Donetick

To configure Donetick to send notifications to Pushover, you need to update your `config.yaml` file with the Pushover configuration. Please check the [Configuration](../getting-started/configration#pushover) documentation for more information on the configuration file.
To configure Donetick to send notifications to Pushover, you need to update your `config.yaml` file with the Pushover configuration. Please check the [Configuration](../getting-started/configuration#pushover) documentation for more information on the configuration file.


Once you have added the configuration, restart Donetick for the changes to take effect.
Expand Down
4 changes: 2 additions & 2 deletions docs/notifications/telegram.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Donetick supports sending notifications to Telegram chat and groups. This guide
## Prerequisites

- Create a Telegram bot
- Descover the chat ID
- Discover the chat ID
- Configure Donetick

## Create a Telegram Bot
Expand All @@ -35,7 +35,7 @@ you can search for `userinfobot` in Telegram and start a chat with it. The bot w

## Configure Donetick

To configure Donetick to send notifications to Telegram, you need to update you `config.yaml` file with the Telegram configuration. Please check the [Configuration](../getting-started/configration#telegram) documentation for more information on the configuration file.
To configure Donetick to send notifications to Telegram, you need to update you `config.yaml` file with the Telegram configuration. Please check the [Configuration](../getting-started/configuration#telegram) documentation for more information on the configuration file.

Once you have added the configuration, restart Donetick for the changes to take effect.

Expand Down
14 changes: 14 additions & 0 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,20 @@ const config = {
locales: ['en'],
},

plugins: [
[
'@docusaurus/plugin-client-redirects',
{
redirects: [
{
from: '/getting-started/configration',
to: '/getting-started/configuration',
},
],
},
],
],

presets: [
[
'classic',
Expand Down
25 changes: 25 additions & 0 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
},
"dependencies": {
"@docusaurus/core": "3.7.0",
"@docusaurus/plugin-client-redirects": "3.7.0",
"@docusaurus/preset-classic": "3.7.0",
"@mdx-js/react": "^3.0.0",
"clsx": "^2.0.0",
Expand Down