{"id":13832287,"url":"https://github.com/FreeCAD/DevelopersHandbook","last_synced_at":"2025-07-09T16:34:55.128Z","repository":{"id":158135160,"uuid":"619910270","full_name":"FreeCAD/DevelopersHandbook","owner":"FreeCAD","description":"A handbook about FreeCAD development","archived":false,"fork":false,"pushed_at":"2024-04-08T21:35:01.000Z","size":1927,"stargazers_count":35,"open_issues_count":26,"forks_count":27,"subscribers_count":22,"default_branch":"main","last_synced_at":"2024-04-14T04:54:06.036Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/FreeCAD.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":"roadmap/index.md","authors":null,"dei":null}},"created_at":"2023-03-27T16:50:03.000Z","updated_at":"2024-04-02T16:32:46.000Z","dependencies_parsed_at":"2024-01-14T14:30:19.591Z","dependency_job_id":"962a593d-1f67-4857-824a-e1e2cb3b18ce","html_url":"https://github.com/FreeCAD/DevelopersHandbook","commit_stats":{"total_commits":129,"total_committers":22,"mean_commits":5.863636363636363,"dds":0.5968992248062015,"last_synced_commit":"4799593a6928b52362e139965c9fa45e77030d73"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FreeCAD%2FDevelopersHandbook","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FreeCAD%2FDevelopersHandbook/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FreeCAD%2FDevelopersHandbook/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FreeCAD%2FDevelopersHandbook/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/FreeCAD","download_url":"https://codeload.github.com/FreeCAD/DevelopersHandbook/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225008206,"owners_count":17406242,"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-08-04T10:01:58.509Z","updated_at":"2024-11-20T14:30:41.411Z","avatar_url":"https://github.com/FreeCAD.png","language":"HTML","funding_links":[],"categories":["HTML"],"sub_categories":[],"readme":"# \u003cimg src=\"images/FreeCAD-symbol.svg\" style=\"width:10%;\" /\u003e Developers Handbook\n\nThis is the repo for the [Developers Handbook](https://freecad.github.io/DevelopersHandbook/).\n\n## Install and run locally\n\nThis handbook uses Jekyll, a static site generator written in Ruby. There are several options for setting up local development. Examples below illustrate the process using Bundler on a Debian-based system, or using a Docker container to keep things separate from the host system. After setup, the handbook will be available at `http://127.0.0.1:4000`.\n\n### Debian-based system setup\n\nAlthough Jekyll is packaged in Debian, the `github-pages` gem is not, so Bundler is required to handle dependencies. It is not necessary to `apt install jekyll`.\n\nBundler requires `ruby-dev` and `build-essential` to build Ruby gem native extensions.\n\n```bash\n$ sudo apt install ruby-bundler ruby-dev build-essential\n$ bundle install\n$ bundle exec jekyll serve\n```\n\n### Docker container setup\n\nDocker bind mounts the handbook source directory inside the container and marks it as private \u0026 unshared with any other container, before calling `jekyll serve` as in the instructions above.\n\n```bash\n$ docker run --rm --volume=\"$PWD:/srv/jekyll:Z\" -it jekyll/jekyll jekyll serve\n```\n\n### References\n\n- [Jekyll installation guidelines](https://jekyllrb.com/docs/installation/)\n- [Ruby 101 notes](https://jekyllrb.com/docs/ruby-101/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FFreeCAD%2FDevelopersHandbook","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FFreeCAD%2FDevelopersHandbook","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FFreeCAD%2FDevelopersHandbook/lists"}