{"id":23952488,"url":"https://github.com/akesson/markdown-includes","last_synced_at":"2026-05-30T16:31:10.317Z","repository":{"id":131985664,"uuid":"611168426","full_name":"akesson/markdown-includes","owner":"akesson","description":"Your markdown documents with includes for externally generated texts and sections","archived":false,"fork":false,"pushed_at":"2023-04-06T07:43:44.000Z","size":50,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-03-04T13:16:03.152Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/akesson.png","metadata":{"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}},"created_at":"2023-03-08T09:05:12.000Z","updated_at":"2024-06-29T12:19:38.000Z","dependencies_parsed_at":null,"dependency_job_id":"960b78f4-09ad-43c8-9afc-9cee8af6deaa","html_url":"https://github.com/akesson/markdown-includes","commit_stats":{"total_commits":12,"total_committers":1,"mean_commits":12.0,"dds":0.0,"last_synced_commit":"c7b4955aeca45e351a34d3cd046f0483eea3ed8b"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/akesson/markdown-includes","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/akesson%2Fmarkdown-includes","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/akesson%2Fmarkdown-includes/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/akesson%2Fmarkdown-includes/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/akesson%2Fmarkdown-includes/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/akesson","download_url":"https://codeload.github.com/akesson/markdown-includes/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/akesson%2Fmarkdown-includes/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33700863,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-05-30T02:00:06.278Z","response_time":92,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":[],"created_at":"2025-01-06T13:58:50.114Z","updated_at":"2026-05-30T16:31:10.276Z","avatar_url":"https://github.com/akesson.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003c!-- \nPlease don't edit. This document has been generated from \"src/README.tpl.md\"\n--\u003e \n# markdown-includes\n\nTable of contents\n\n- [markdown-includes](#markdown-includes)\n    - [rustdoc](#rustdoc)\n    - [Example](#example)\n\n---\n\nA simple way of including other files, rust doc and table of content in a markdown file.\n\nFor a repo's README file, you'll create a _README.tpl.md_ which you can edit like a normal\nmarkdown file, but with the added support for fenced includes which are TOML fences with\nan extra name containing the configuration of the include.\n\n## rustdoc\n\nThe rustdoc part of this crate is based on modified code from [cargo-rdme](https://crates.io/crates/cargo-rdme).\nThe same limitations apply, especially for the syntax of [intralinks](https://github.com/orium/cargo-rdme#intralinks)\n\n## Example\n\n_src/README.tpl.md_:\n\u003e My title\u003cbr\u003e\n\u003e \u003cbr\u003e\n\u003e Include a table of content:\u003cbr\u003e\n\u003e \u0026#96;\u0026#96;\u0026#96;toml toc\u003cbr\u003e\n\u003e header = \"# Table of contents\"\u003cbr\u003e\n\u003e \u0026#96;\u0026#96;\u0026#96;\u003cbr\u003e\n\u003e \u003cbr\u003e\n\u003e Extracted from lib.rs' rust doc:\u003cbr\u003e\n\u003e \u003cbr\u003e\n\u003e \u0026#96;\u0026#96;\u0026#96;toml rustdoc\u003cbr\u003e\n\u003e source = \"lib.rs\"\u003cbr\u003e\n\u003e \u0026#96;\u0026#96;\u0026#96;\u003cbr\u003e\n\n\nTo generate a _README.md_ file you add a test:\n\n```rust\n#[test]\nfn update_readme() {\n    markdown_includes::update(\"src/README.tpl.md\", \"README.md\").unwrap();\n}\n```\n\nThis test will update the README file if necessary, but if running\nin a CI pipeline (the CI environment variable is set),\nit will fail if the _README.md_ needs updating.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fakesson%2Fmarkdown-includes","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fakesson%2Fmarkdown-includes","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fakesson%2Fmarkdown-includes/lists"}