{"id":13480621,"url":"https://github.com/rust-lang/nomicon","last_synced_at":"2025-10-23T15:06:31.735Z","repository":{"id":18693228,"uuid":"83736661","full_name":"rust-lang/nomicon","owner":"rust-lang","description":"The Dark Arts of Advanced and Unsafe Rust Programming","archived":false,"fork":false,"pushed_at":"2025-04-15T20:56:57.000Z","size":1339,"stargazers_count":2020,"open_issues_count":92,"forks_count":287,"subscribers_count":54,"default_branch":"master","last_synced_at":"2025-05-08T00:03:50.226Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://doc.rust-lang.org/nomicon/","language":"CSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rust-lang.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE-APACHE","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-03-02T23:49:34.000Z","updated_at":"2025-05-07T22:24:35.000Z","dependencies_parsed_at":"2023-12-10T04:20:45.438Z","dependency_job_id":"5d4773c8-faa4-49a0-843e-28aa0f7cca39","html_url":"https://github.com/rust-lang/nomicon","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rust-lang%2Fnomicon","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rust-lang%2Fnomicon/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rust-lang%2Fnomicon/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rust-lang%2Fnomicon/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rust-lang","download_url":"https://codeload.github.com/rust-lang/nomicon/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254052692,"owners_count":22006716,"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-07-31T17:00:42.644Z","updated_at":"2025-10-23T15:06:26.694Z","avatar_url":"https://github.com/rust-lang.png","language":"CSS","funding_links":[],"categories":["CSS","Credits"],"sub_categories":[],"readme":"# The Rustonomicon\n\nThe Dark Arts of Advanced and Unsafe Rust Programming\n\nNicknamed \"the Nomicon.\"\n\n## NOTE: This is a draft document, and may contain serious errors\n\n\u003e Instead of the programs I had hoped for, there came only a shuddering\nblackness and ineffable loneliness; and I saw at last a fearful truth which no\none had ever dared to breathe before — the unwhisperable secret of secrets — The\nfact that this language of stone and stridor is not a sentient perpetuation of\nRust as London is of Old London and Paris of Old Paris, but that it is in fact\nquite unsafe, its sprawling body imperfectly embalmed and infested with queer\nanimate things which have nothing to do with it as it was in compilation.\n\nThis book digs into all the awful details that are necessary to understand in\norder to write correct Unsafe Rust programs. Due to the nature of this problem,\nit may lead to unleashing untold horrors that shatter your psyche into a billion\ninfinitesimal fragments of despair.\n\n## Requirements\n\nBuilding the Nomicon requires [mdBook]. To get it:\n\n[mdBook]: https://github.com/rust-lang/mdBook\n\n```bash\ncargo install mdbook\n```\n\n### `mdbook` usage\n\nTo build the Nomicon use the `build` sub-command:\n\n```bash\nmdbook build\n```\n\nThe output will be placed in the `book` subdirectory. To check it out, open the\n`index.html` file in your web browser. You can pass the `--open` flag to `mdbook\nbuild` and it'll open the index page in your default browser (if the process is\nsuccessful) just like with `cargo doc --open`:\n\n```bash\nmdbook build --open\n```\n\nThere is also a `test` sub-command to test all code samples contained in the book:\n\n```bash\nmdbook test\n```\n\n### `linkcheck`\n\nWe use the `linkcheck` tool to find broken links.\nTo run it locally:\n\n```sh\ncurl -sSLo linkcheck.sh https://raw.githubusercontent.com/rust-lang/rust/master/src/tools/linkchecker/linkcheck.sh\nsh linkcheck.sh --all nomicon\n```\n\n## Contributing\n\nGiven that the Nomicon is still in a draft state, we'd love your help! Please\nfeel free to open issues about anything, and send in PRs for things you'd like\nto fix or change. If your change is large, please open an issue first, so we can\nmake sure that it's something we'd accept before you go through the work of\ngetting a PR together.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frust-lang%2Fnomicon","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frust-lang%2Fnomicon","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frust-lang%2Fnomicon/lists"}