{"id":15369919,"url":"https://github.com/tokusumi/markdown-embed-code","last_synced_at":"2025-10-24T03:14:31.677Z","repository":{"id":44871169,"uuid":"313290642","full_name":"tokusumi/markdown-embed-code","owner":"tokusumi","description":"Action to synchronize \"any\" code in markdown with an external file. No more managing code as plain text.","archived":false,"fork":false,"pushed_at":"2022-10-06T00:35:47.000Z","size":33,"stargazers_count":28,"open_issues_count":4,"forks_count":13,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-05-02T03:12:48.736Z","etag":null,"topics":["github-action","markdown"],"latest_commit_sha":null,"homepage":"","language":"Python","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/tokusumi.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}},"created_at":"2020-11-16T12:10:38.000Z","updated_at":"2023-11-17T09:02:52.000Z","dependencies_parsed_at":"2023-01-11T17:22:41.158Z","dependency_job_id":null,"html_url":"https://github.com/tokusumi/markdown-embed-code","commit_stats":{"total_commits":29,"total_committers":4,"mean_commits":7.25,"dds":"0.48275862068965514","last_synced_commit":"8b81fe2e5585c5e1d14772d8e712ecb7a69c74c8"},"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tokusumi%2Fmarkdown-embed-code","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tokusumi%2Fmarkdown-embed-code/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tokusumi%2Fmarkdown-embed-code/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tokusumi%2Fmarkdown-embed-code/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tokusumi","download_url":"https://codeload.github.com/tokusumi/markdown-embed-code/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249085474,"owners_count":21210267,"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":["github-action","markdown"],"created_at":"2024-10-01T13:39:15.231Z","updated_at":"2025-10-24T03:14:26.636Z","avatar_url":"https://github.com/tokusumi.png","language":"Python","readme":"# markdown-embed-code\n\nEmbedding code into markdown from external file.\nAny language's code blocks are available.\n\nSee [demo repo](https://github.com/tokusumi/readme-code-testing) if you are interested in testing code within README.\n\n## How to use\n\nIn markdown, write code block as follows:\n\n````markdown\n```python:tests/src/sample.py\n\n```\n\nAnd, you can refer specific lines as\n```python:tests/src/sample.py [4-5]\n \n```\n````\n\nThen, this action referes to `tests/src/sample.py` and modifies markdown as (if something code is written, they are overridden):\n\n```python:tests/src/sample.py\nfrom math import sqrt\n\n\ndef sample(x):\n    return sqrt(x)\n\n```\n\nAnd, specific lines is refered as\n\n```python:tests/src/sample.py [4-5]\ndef sample(x):\n    return sqrt(x)\n```\n\nNOTE: Read file by passed path, where the top directory in your repo is working directory. If the path is wrong, this action is failed.\n\n### How to use - workflow example\n\nOverride README.md and push by action if readme is changed:\n\n```yaml\nname: Embed code in README\n\non:\n  pull_request:\n    branches:\n      - main\n\njobs:\n  embed-code:\n    runs-on: ubuntu-latest\n    steps:\n      - uses: actions/checkout@v2\n        with:\n          persist-credentials: false # otherwise, the token used is the GITHUB_TOKEN, instead of your personal token\n          fetch-depth: 0 # otherwise, you will failed to push refs to dest repo\n          ref: refs/heads/${{ github.head_ref }}\n\n      - uses: tokusumi/markdown-embed-code@main\n        with:\n          markdown: \"README.md\"\n          token: ${{ secrets.GITHUB_TOKEN }}\n          message: \"synchronizing Readme\"\n          silent: true\n```\n\n### Configuration\n\n| input                | description                                                             |\n| -------------------- | ----------------------------------------------------------------------- |\n| token                | Token for the repo. Can be passed in using {{ secrets.GITHUB_TOKEN }}   |\n| markdown (Optional)  | Target markdown file path. (default: \"README.md\")                       |\n| message (Optional)   | Commit message for action. (default: \"Embedding code into Markdown\")    |\n| no_change (Optional) | Issue comment at no changed (default: \"No changes on README!\" )         |\n| output (Optional)    | Output markdown file path. If none, override target file. (default: \"\") |\n| silent (Optional)    | No issue comment in silent mode (default: false)                        |\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftokusumi%2Fmarkdown-embed-code","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftokusumi%2Fmarkdown-embed-code","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftokusumi%2Fmarkdown-embed-code/lists"}