https://github.com/gothenburgbitfactory/tw.org
Repository for tw.org site
https://github.com/gothenburgbitfactory/tw.org
site
Last synced: 11 months ago
JSON representation
Repository for tw.org site
- Host: GitHub
- URL: https://github.com/gothenburgbitfactory/tw.org
- Owner: GothenburgBitFactory
- Created: 2018-02-03T17:25:14.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2025-08-14T01:32:36.000Z (11 months ago)
- Last Synced: 2025-08-14T03:24:58.440Z (11 months ago)
- Topics: site
- Language: Perl
- Homepage: https://taskwarrior.org
- Size: 62.2 MB
- Stars: 10
- Watchers: 6
- Forks: 46
- Open Issues: 27
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# taskwarrior.org Site Repository
This repository contains the content of [taskwarrior.org](https://taskwarrior.org), the website for the [Taskwarrior](https://github.com/GothenburgBitFactory/taskwarrior) project.
## Contributing
To clone this repository, run
```shell
git clone https://github.com/GothenburgBitFactory/tw.org
```
For minor changes, it is perfectly fine to simply change the relevant Markdown files and make a pull request.
For more complex changes, here is how to build the documentation locally:
1. Install [hugo](https://gohugo.io/getting-started/quick-start/).
2. Run
```shell
hugo server -D -w
```
This defaults to running a web server on `http://localhost:1313`.
If you are running on an external host, try
```shell
hugo server -D -w --bind 0.0.0.0 -b http://
```
## Updating Taskwarrior Versions
To record a new release of Taskwarrior, run `bin/tw-release vX.Y.Z` and make a PR for the result.
## Updating Tools
This repository has automation for searching GitHub for projects related to Taskwarrior and including them in the "Tools" page.
On first usage, generate API tokens and store them safely for later:
* [GitHub](https://github.com/settings/tokens): requires no special scopes
Then set up the Python 3 environment:
```sh
# Create a virtual environment to avoid clobbering global installation
$ python3 -m venv venv
# Activate the virtual environment
$ source venv/bin/activate
# Install dependencies
$ pip install -r bin/requirements.txt
```
Then create the `update_tools.sh` script by copying the sample, and set API keys there. This file will be ignored and should not be committed.
Now that everything is set up, the tools can be updated by running `update_tools.sh`:
```sh
$ source venv/bin/activate
$ ./update_tools.sh
```
Repositories that are **always included** are listed in `tools/always_include.json`. Repositories that are **always ignored** are listed in `tools/never_include.json`. This can be modified and committed to the repository.