{"id":18587663,"url":"https://github.com/darktable-org/dtdocs","last_synced_at":"2025-04-04T09:07:12.355Z","repository":{"id":37027838,"uuid":"287529064","full_name":"darktable-org/dtdocs","owner":"darktable-org","description":"darktable user manual","archived":false,"fork":false,"pushed_at":"2025-03-11T19:05:52.000Z","size":170758,"stargazers_count":82,"open_issues_count":38,"forks_count":87,"subscribers_count":9,"default_branch":"master","last_synced_at":"2025-03-28T08:06:13.745Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/darktable-org.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-08-14T12:35:17.000Z","updated_at":"2025-03-11T19:02:44.000Z","dependencies_parsed_at":"2023-02-19T02:15:44.671Z","dependency_job_id":"70cee505-5830-45a5-81d4-8e8c744448ca","html_url":"https://github.com/darktable-org/dtdocs","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/darktable-org%2Fdtdocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/darktable-org%2Fdtdocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/darktable-org%2Fdtdocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/darktable-org%2Fdtdocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/darktable-org","download_url":"https://codeload.github.com/darktable-org/dtdocs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247149500,"owners_count":20891954,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-07T00:40:16.865Z","updated_at":"2025-04-04T09:07:12.331Z","avatar_url":"https://github.com/darktable-org.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# darktable Documentation\n\nThis 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.\n\nThis 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/.\n\nThe user manual for the current stable release of darktable can be found at [darktable.org](https://docs.darktable.org/usermanual/stable/en/).\n\n## Contributing\n\nPlease see https://darktable-org.github.io/dtdocs/en/special-topics/contributing/ for information about contributing content\n\nFor 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.\n\n## Obtaining and Building\n\n### Cloning\n\nThe 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.\nIn order to clone these submodules along with the site you just need to add the flag `--recurse-submodules` to the clone command:\n\n    git clone --recurse-submodules https://github.com/darktable-org/dtdocs.git\n\nIf you already have the site cloned, but haven't included the submodules before:\n\n    git submodule update --init --recursive\n\n\n### Hugo\n\nThis site is built with the static site generator [Hugo](https://github.com/gohugoio/hugo) (*extended*).\n\nYou 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/).\n\n#### SASS\n\nIf cloning the repo fresh, remember to build the bootstrap assets locally:\n\n```\n$ cd ./themes/hugo-darktable-docs-theme/assets/\n$ yarn install (or alternatively `npm install`)\n$ cd ../../hugo-darktable-docs-pdf-theme/assets/\n$ yarn install\n```\n\n### Updating\n\nIf 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).\n\nAs normal, from the project root directory, update things like normal:\n```\ngit pull\n```\n\nDouble check that the submodule is being updated as well:\n```\ngit submodule update --init --recursive\n```\n\nAnd finally make sure the assets are built:\n```\ncd themes/hugo-darktable-docs-theme/assets/\nyarn install (or alternatively `npm install`).\n```\nThis should get things up and running.\n\n\n### Building\n\nYou can build the HTML website locally, the production site to deploy to hosting, or the PDF.\n\n## Local Website\n\nBuilding the site to test locally can be done from the root of the repo.\n\n```\n$ hugo server -D --disableFastRender\n```\n\nThe site should then be available at http://localhost:1313/usermanual/development/ (you can see the URL in the output of the `hugo server` command).\n\n## Production Website\n\nRun the `hugo` command:\n\n```\nhugo\n```\n\nThe 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.\n\n## PDF\n\nEnsure you have the [`weasyprint`](https://weasyprint.org) application installed; this will transform the generated HTML to PDF.\n\n```\nmkdir -p public\nhugo server --disableFastRender --config config-pdf.yaml\nweasyprint http://localhost:1313/dtdocs/index.html public/darktable_user_manual.pdf\npkill hugo\n```\n\nThe PDF is available in the `public` directory.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdarktable-org%2Fdtdocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdarktable-org%2Fdtdocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdarktable-org%2Fdtdocs/lists"}