https://github.com/darktable-org/dtdocs
darktable user manual
https://github.com/darktable-org/dtdocs
Last synced: about 1 year ago
JSON representation
darktable user manual
- Host: GitHub
- URL: https://github.com/darktable-org/dtdocs
- Owner: darktable-org
- License: gpl-3.0
- Created: 2020-08-14T12:35:17.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2025-03-11T19:05:52.000Z (over 1 year ago)
- Last Synced: 2025-03-28T08:06:13.745Z (over 1 year ago)
- Language: Shell
- Homepage:
- Size: 163 MB
- Stars: 82
- Watchers: 9
- Forks: 87
- Open Issues: 38
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# darktable Documentation
This is the user documentation for [darktable](https://darktable.org). The content is authored in markdown and rendered to HTML using [Hugo](https://gohugo.io) as well as to PDF and ePub.
This repository tracks the current darktable development version. The auto-built website for the development user manual can be found at https://darktable-org.github.io/dtdocs/.
The user manual for the current stable release of darktable can be found at [darktable.org](https://docs.darktable.org/usermanual/stable/en/).
## Contributing
Please see https://darktable-org.github.io/dtdocs/en/special-topics/contributing/ for information about contributing content
For a complete list of the outstanding work please see the [issues](https://github.com/darktable-org/dtdocs/issues) in this repository and a list of [undocumented pull requests](https://github.com/darktable-org/darktable/pulls?q=is%3Apr+label%3Adocumentation-pending+is%3Aclosed) in the darktable repository.
## Obtaining and Building
### Cloning
The themes for the site and PDF use [hugo-darktable-docs-theme](https://github.com/pixlsus/hugo-darktable-docs-theme.git) and [hugo-darktable-docs-pdf-theme](https://github.com/pixlsus/hugo-darktable-docs-pdf-theme.git) as git submodules.
In order to clone these submodules along with the site you just need to add the flag `--recurse-submodules` to the clone command:
git clone --recurse-submodules https://github.com/darktable-org/dtdocs.git
If you already have the site cloned, but haven't included the submodules before:
git submodule update --init --recursive
### Hugo
This site is built with the static site generator [Hugo](https://github.com/gohugoio/hugo) (*extended*).
You can use a prebuilt binary of the latest *extended* version for your system. A detailed guide for installation of the prebuilt binaries is given in the [Hugo installation documentation](https://gohugo.io/installation/).
#### SASS
If cloning the repo fresh, remember to build the bootstrap assets locally:
```
$ cd ./themes/hugo-darktable-docs-theme/assets/
$ yarn install (or alternatively `npm install`)
$ cd ../../hugo-darktable-docs-pdf-theme/assets/
$ yarn install
```
### Updating
If you have the repo cloned but need to update things, it helps to make sure everything is up to date (since we are also using a submodule for the base theme).
As normal, from the project root directory, update things like normal:
```
git pull
```
Double check that the submodule is being updated as well:
```
git submodule update --init --recursive
```
And finally make sure the assets are built:
```
cd themes/hugo-darktable-docs-theme/assets/
yarn install (or alternatively `npm install`).
```
This should get things up and running.
### Building
You can build the HTML website locally, the production site to deploy to hosting, or the PDF.
## Local Website
Building the site to test locally can be done from the root of the repo.
```
$ hugo server -D --disableFastRender
```
The site should then be available at http://localhost:1313/usermanual/development/ (you can see the URL in the output of the `hugo server` command).
## Production Website
Run the `hugo` command:
```
hugo
```
The static files are now available to deploy to a webhost in the `public` directory. This is currently performed automatically when new changes are pushed to the master branch, via github Actions.
## PDF
Ensure you have the [`weasyprint`](https://weasyprint.org) application installed; this will transform the generated HTML to PDF.
```
mkdir -p public
hugo server --disableFastRender --config config-pdf.yaml
weasyprint http://localhost:1313/dtdocs/index.html public/darktable_user_manual.pdf
pkill hugo
```
The PDF is available in the `public` directory.