{"id":28461243,"url":"https://github.com/cryptpad/documentation","last_synced_at":"2026-02-09T16:02:22.529Z","repository":{"id":41909231,"uuid":"287555023","full_name":"cryptpad/documentation","owner":"cryptpad","description":"Documentation for CryptPad, a collaboration suite that is encrypted and open-source.","archived":false,"fork":false,"pushed_at":"2026-01-20T09:24:31.000Z","size":74313,"stargazers_count":32,"open_issues_count":4,"forks_count":19,"subscribers_count":12,"default_branch":"staging","last_synced_at":"2026-01-20T18:55:40.248Z","etag":null,"topics":["cryptpad","docs","documentation","sphinx"],"latest_commit_sha":null,"homepage":"https://docs.cryptpad.org","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"cc-by-4.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cryptpad.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null},"funding":{"github":null,"patreon":null,"open_collective":"cryptpad","ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"lfx_crowdfunding":null,"custom":null}},"created_at":"2020-08-14T14:42:59.000Z","updated_at":"2025-12-15T13:00:13.000Z","dependencies_parsed_at":"2025-10-14T18:31:39.997Z","dependency_job_id":null,"html_url":"https://github.com/cryptpad/documentation","commit_stats":{"total_commits":1661,"total_committers":44,"mean_commits":37.75,"dds":0.8151715833835039,"last_synced_commit":"a1cc3bb314043a33114b04c027d0aa5744d3f092"},"previous_names":[],"tags_count":11,"template":false,"template_full_name":null,"purl":"pkg:github/cryptpad/documentation","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cryptpad%2Fdocumentation","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cryptpad%2Fdocumentation/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cryptpad%2Fdocumentation/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cryptpad%2Fdocumentation/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cryptpad","download_url":"https://codeload.github.com/cryptpad/documentation/tar.gz/refs/heads/staging","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cryptpad%2Fdocumentation/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29271856,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-09T13:47:44.167Z","status":"ssl_error","status_checked_at":"2026-02-09T13:47:43.721Z","response_time":56,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["cryptpad","docs","documentation","sphinx"],"created_at":"2025-06-07T03:08:04.034Z","updated_at":"2026-02-09T16:02:22.515Z","avatar_url":"https://github.com/cryptpad.png","language":"HTML","funding_links":["https://opencollective.com/cryptpad"],"categories":[],"sub_categories":[],"readme":"# CryptPad Documentation\n## Installation \n\nWe use [UV](https://docs.astral.sh/uv/#getting-started) to maintain the development environment for the documentation. Install dependencies with \n\n```bash\nuv sync\n```\n\nActivate the environment with \n\n```bash\nsource ./.venv/bin/activate\n```\n\nKeep `requirements.txt` up to date with the UV venv by running\n\n```bash\nuv export --format requirements-txt \u003e requirements.txt\n```\n\n### Pip\n```bash\npip install -r requirements.txt\n```\n\n## Build\nEnglish `en` is the default language.\n\nto build the default:  \n```bash\nmake html\n```\n\nto build another language, e.g. French: \n```bash\nmake -e SPHINXOPTS=\"-D language='fr'\" html\n```\n\nView the result in `/_build/html/`\n\n## Translations\nIf you are interested in translating this documentation, you can use our [Weblate project](https://weblate.cryptpad.org/projects/user-guide/) for the user guide. If your language is not listed, please [contact the development team](https://cryptpad.fr/contact.html) to add it.\n\nTo add a new language\n```\nsphinx-intl update --pot-dir _build/gettext -l de\n```\nchange `de` to the locale you want to add\n\n### Translated builds\nTo update after default language has changed:  \n```bash\nsphinx-intl update -p _build/locale\n```\n\nTo generate `.po` files for a new language e.g. French:  \n```bash\nmake gettext\nsphinx-intl update -p _build/gettext -l fr\n```\n\n[update.sh](update.sh) updates all languages after English has changed: \n```bash\n./update.sh\n```\n\n[build.sh](build.sh) builds all languages into the `www` folder: \n```bash\n./build.sh\n```\n\n### Adding a language\n1. add language code to `LANG` and leave an empty line at the end of the file\n2. add the `\u003coption\u003e` to `_themes/theme/layout.html` line 109\n\n### translated images\nImages for English are in the `/images` folder.  \nTo provide localised versions of images, place them in a folder such as `images/fr/`.\n\n## Licenses\nThe content of this documentation is licensed under the [Creative Commons Attribution 4.0 International](LICENSE) (CC-BY).\n\nThe theme is modified from the [Krita documentation](https://invent.kde.org/documentation/docs-krita-org/-/tree/master/) and licensed under the [GNU Free Documentation License](_themes/theme/LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcryptpad%2Fdocumentation","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcryptpad%2Fdocumentation","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcryptpad%2Fdocumentation/lists"}