{"id":13896739,"url":"https://github.com/crystal-lang/crystal-book","last_synced_at":"2025-05-15T04:04:23.837Z","repository":{"id":9426141,"uuid":"62080368","full_name":"crystal-lang/crystal-book","owner":"crystal-lang","description":"Crystal reference with language specification, manuals and learning materials","archived":false,"fork":false,"pushed_at":"2025-05-07T22:24:57.000Z","size":1420,"stargazers_count":404,"open_issues_count":73,"forks_count":250,"subscribers_count":34,"default_branch":"master","last_synced_at":"2025-05-07T23:27:17.161Z","etag":null,"topics":["crystal","documentation","tutorial"],"latest_commit_sha":null,"homepage":"https://crystal-lang.org/reference","language":"Makefile","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/crystal-lang.png","metadata":{"funding":{"open_collective":"crystal-lang"},"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,"zenodo":null}},"created_at":"2016-06-27T18:56:46.000Z","updated_at":"2025-05-07T22:25:01.000Z","dependencies_parsed_at":"2023-02-18T08:00:55.354Z","dependency_job_id":"26e2d1b2-29be-43a2-8687-806b7dabc8e8","html_url":"https://github.com/crystal-lang/crystal-book","commit_stats":{"total_commits":805,"total_committers":221,"mean_commits":"3.6425339366515836","dds":0.8372670807453416,"last_synced_commit":"d1ce01033aa42a03be57f285173fcf14ab6e58a3"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crystal-lang%2Fcrystal-book","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crystal-lang%2Fcrystal-book/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crystal-lang%2Fcrystal-book/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/crystal-lang%2Fcrystal-book/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/crystal-lang","download_url":"https://codeload.github.com/crystal-lang/crystal-book/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254270641,"owners_count":22042858,"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":["crystal","documentation","tutorial"],"created_at":"2024-08-06T18:03:07.401Z","updated_at":"2025-05-15T04:04:23.812Z","avatar_url":"https://github.com/crystal-lang.png","language":"Makefile","funding_links":["https://opencollective.com/crystal-lang"],"categories":["Makefile"],"sub_categories":[],"readme":"# Crystal Programming Language\n\nThis is the language reference for the Crystal programming language.\n\nCrystal is a programming language with the following goals:\n\n* Have a syntax similar to Ruby (but compatibility with it is not a goal).\n* Be statically type-checked, but without having to specify the type of variables or method parameters.\n* Be able to call C code by writing bindings to it in Crystal.\n* Have compile-time evaluation and generation of code, to avoid boilerplate code.\n* Compile to efficient native code.\n\n**Crystal's standard library is documented in the [API docs](https://crystal-lang.org/api).**\n\n## Contributing to the Language Reference\n\nDo you consider yourself a helpful person? If you find bugs or sections\nwhich need more clarification you're welcome to contribute to this\nlanguage reference. You can submit a pull request to this repository:\nhttps://github.com/crystal-lang/crystal-book\n\nThank you very much!\n\n### Branches\n\nThere is a separate branch for every minor Crystal release, all deployed alongside each other on https://crystal-lang.org/reference/\nTypically, only branches of maintained releases receive updates, i.e. the branch for the most recent Crystal release.\n\n* Changes that apply to the current Crystal release should go into the most recent `release/*` branch.\n* Changes that apply to yet unreleased features should go into `master`. They'll be part of the `release/*` branch for the next release.\n  The `master` branch is deployed at https://crystal-lang.org/reference/master/\n\n### Building and Serving Locally\n\n```console\n$ git clone https://github.com/crystal-lang/crystal-book\n$ cd crystal-book\n$ pip install -r requirements.txt\n```\n\nLive preview (at http://127.0.0.1:8000):\n\n```console\n$ make serve\nINFO    -  Building documentation...\nINFO    -  Cleaning site directory\nINFO    -  Documentation built in 3.02 seconds\nINFO    -  Serving on http://127.0.0.1:8000\n...\n```\n\nBuild into the `site` directory (some functionality won't work if opening the files locally):\n\n```console\n$ make build\n```\n\n### devenv environment\n\nThis project includes configuration for a reproducible environment via [devenv.sh](https://devenv.sh/)\nwith integrated pre-commit checks.\n\nLive preview (at http://127.0.0.1:8000):\n\n```console\n$ devenv up\nBuilding shell ...\npre-commit-hooks.nix: hooks up to date\n17:37:13 system  | serve.1 started (pid=6507)\n17:37:13 serve.1 | INFO     -  Building documentation...\n17:37:13 serve.1 | INFO     -  Cleaning site directory\n17:37:16 serve.1 | INFO     -  Documentation built in 2.64 seconds\n17:37:16 serve.1 | INFO     -  [17:37:16] Watching paths for changes: 'docs', 'mkdocs.yml'\n17:37:16 serve.1 | INFO     -  [17:37:16] Serving on http://127.0.0.1:8000/reference/latest/\n````\n\nBuild the site:\n\n```console\n$ devenv shell build\nBuilding shell ...\npre-commit-hooks.nix: hooks up to date\nrm -rf ./site\nmkdocs build -d ./site  --strict\nINFO     -  Cleaning site directory\nINFO     -  Building documentation to directory: ./site\nINFO     -  Documentation built in 2.43 seconds\n```\n\nEnter the development shell and build the site from there:\n\n```console\n$ devenv shell\nBuilding shell ...\nEntering shell ...\n\npre-commit-hooks.nix: hooks up to date\n$(devenv) make build\nmkdocs build -d ./site  --strict\nINFO     -  Cleaning site directory\nINFO     -  Building documentation to directory: ./site\nINFO     -  Documentation built in 2.43 seconds\n```\n\nRun pre-commit checks on the entire repository:\n\n```console\n$ devenv ci\n```\n\n### Adding a page\n\nTo add a page, create a Markdown file in the desired location. Then, add a link in the `SUMMARY.md` file which acts as the navigation for the language reference.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcrystal-lang%2Fcrystal-book","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcrystal-lang%2Fcrystal-book","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcrystal-lang%2Fcrystal-book/lists"}