{"id":28408920,"url":"https://github.com/librepcb/librepcb-doc","last_synced_at":"2025-06-24T22:31:26.578Z","repository":{"id":46277329,"uuid":"112958531","full_name":"LibrePCB/librepcb-doc","owner":"LibrePCB","description":"Official documentation of LibrePCB","archived":false,"fork":false,"pushed_at":"2025-06-04T09:40:20.000Z","size":12361,"stargazers_count":18,"open_issues_count":8,"forks_count":16,"subscribers_count":8,"default_branch":"master","last_synced_at":"2025-06-22T16:23:44.595Z","etag":null,"topics":["hacktoberfest"],"latest_commit_sha":null,"homepage":"https://librepcb.org/docs/","language":"Answer Set Programming","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"cc0-1.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/LibrePCB.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.txt","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,"zenodo":null}},"created_at":"2017-12-03T19:52:18.000Z","updated_at":"2025-06-04T09:40:21.000Z","dependencies_parsed_at":"2023-12-15T16:01:00.399Z","dependency_job_id":"1c438c8c-5332-472b-a260-b8d233f92011","html_url":"https://github.com/LibrePCB/librepcb-doc","commit_stats":{"total_commits":132,"total_committers":11,"mean_commits":12.0,"dds":"0.16666666666666663","last_synced_commit":"072c1cd598fc7dc85012cadc3dba1d9662e0b45a"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/LibrePCB/librepcb-doc","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LibrePCB%2Flibrepcb-doc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LibrePCB%2Flibrepcb-doc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LibrePCB%2Flibrepcb-doc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LibrePCB%2Flibrepcb-doc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/LibrePCB","download_url":"https://codeload.github.com/LibrePCB/librepcb-doc/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LibrePCB%2Flibrepcb-doc/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261766635,"owners_count":23206663,"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":["hacktoberfest"],"created_at":"2025-06-02T04:38:06.632Z","updated_at":"2025-06-24T22:31:26.570Z","avatar_url":"https://github.com/LibrePCB.png","language":"Answer Set Programming","funding_links":[],"categories":[],"sub_categories":[],"readme":"# LibrePCB Documentation\n\nThis repository contains the source for the [LibrePCB](http://librepcb.org)\ndocumentation hosted at [docs.librepcb.org](https://docs.librepcb.org).\n\n## Toolchain\n\nThe documentation is written in\n[Asciidoc](https://asciidoctor.org/docs/what-is-asciidoc/)\nand built with [Antora](https://antora.org/).\n\nUnfortunately the build setup is not trivial since it is integrated into\n[librepcb-website](https://github.com/LibrePCB/librepcb-website).\n\nTherefore we created a Docker image containing the whole toolchain. On Linux,\njust make sure Docker is installed. Then building the documentation is as\nsimple as calling this script:\n\n    ./build.sh\n\nUnfortunately on other operating systems it is much more complicated. However,\nhaving the toolchain available locally is not mandatory. A decent text editor\n(ideally with AsciiDoc syntax highligting and live preview) should be enough\nto write some documentation.\n\n## Virtual Machine For Screenshots\n\nTo ensure a consistent look\u0026feel across all screenshots, please use a\nvirtual machine (e.g. VirtualBox) and run LibrePCB within it. Set up\nthe VM as following:\n\n- Operating system: Ubuntu 22.04 (Choose \"Minimal installation\")\n- Locale: English (`en_US`)\n- Computer name: librepcb\n- Full user name: Me\n- Username: user\n\nAfter the installation:\n\n- Set the VM screen resolution to 1024x768 to ensure no screenshot is larger\n  than this.\n- On the bottom right of the login screen, switch from Wayland to X11 since\n  most screenshot capture tools do not work properly on Wayland.\n- Run `sudo apt install shutter` to install Shutter for capturing screenshots.\n- In the Shutter settings, enable rounded corners.\n\n## Contributing\n\nContributions are very welcome! See our [Contributing Guide](CONTRIBUTING.md)\nfor details. We're looking forward for pull requests :)\n\n## Links\n\n- [AsciiDoc Syntax Quick Reference](https://asciidoctor.org/docs/asciidoc-syntax-quick-reference/)\n- [Asciidoc Writer's Guide](https://asciidoctor.org/docs/asciidoc-writers-guide/)\n- [Antora Documentation](https://docs.antora.org/antora/latest/)\n- [Asciidoctor User Manual](https://asciidoctor.org/docs/user-manual/)\n- [AsciidocFX](https://www.asciidocfx.com/) (Asciidoc editor with live preview)\n\n## License\n\nThis documentation is published under the\n[CC0 1.0 Universal](https://creativecommons.org/publicdomain/zero/1.0/legalcode)\nlicense.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flibrepcb%2Flibrepcb-doc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flibrepcb%2Flibrepcb-doc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flibrepcb%2Flibrepcb-doc/lists"}