{"id":13612330,"url":"https://github.com/flant/jekyll_include_plugin","last_synced_at":"2025-10-15T17:44:29.003Z","repository":{"id":47705029,"uuid":"378139155","full_name":"flant/jekyll_include_plugin","owner":"flant","description":"Plugin for including contents of local/remote plain text files (or parts of them) into your pages. Allows for multilang comments in the included files.","archived":false,"fork":false,"pushed_at":"2025-03-19T16:09:35.000Z","size":29,"stargazers_count":13,"open_issues_count":1,"forks_count":2,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-06-05T07:38:37.901Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Ruby","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/flant.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","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":"2021-06-18T12:10:59.000Z","updated_at":"2025-03-19T16:09:34.000Z","dependencies_parsed_at":"2024-11-07T20:33:09.099Z","dependency_job_id":null,"html_url":"https://github.com/flant/jekyll_include_plugin","commit_stats":{"total_commits":22,"total_committers":3,"mean_commits":7.333333333333333,"dds":"0.13636363636363635","last_synced_commit":"9abf1766f90e2318e36132943a5581d3f62290da"},"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"purl":"pkg:github/flant/jekyll_include_plugin","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flant%2Fjekyll_include_plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flant%2Fjekyll_include_plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flant%2Fjekyll_include_plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flant%2Fjekyll_include_plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/flant","download_url":"https://codeload.github.com/flant/jekyll_include_plugin/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flant%2Fjekyll_include_plugin/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":267438411,"owners_count":24087210,"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","status":"online","status_checked_at":"2025-07-27T02:00:11.917Z","response_time":82,"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":"2024-08-01T20:00:27.940Z","updated_at":"2025-10-15T17:44:23.958Z","avatar_url":"https://github.com/flant.png","language":"Ruby","funding_links":[],"categories":["Tags"],"sub_categories":[],"readme":"# Jekyll Include Plugin\n\nInclude contents of local/remote plain text files (or parts of them) into your pages.\nAllows multilang comments in the included files, which language will be used depends on `{{ page.lang }}`.\n\n## Usage\n\nBasic usage as follows:\n\n```jinja\n/jekyllroot/pages/foo.md:\n-----------------------\nlang: en\n-----------------------\n{% include_file \"foo/Dockerfile\" snippet=\"system_deps\" syntax=\"Dockerfile\" %}\n```\n\n```Dockerfile\n/jekyllroot/foo/Dockerfile:\n--------------------------------------------------------\nFROM ruby\n\n# [\u003csnippet system_deps\u003e]\n# [\u003cen\u003e] Install system dependencies\n# [\u003cen\u003e] (multiline possible too)\n# [\u003cru\u003e] Установка системных зависимостей\nRUN apt update \u0026\u0026 apt install curl -y\n# [\u003cendsnippet system_deps\u003e]\n```\n\nResult:\n```Dockerfile\n# Install system dependencies\n# (multiline possible too)\nRUN apt update \u0026\u0026 apt install curl -y\n```\n\nInclude the local file (path is relative to Jekyll root):\n```jinja\n{% include_file \"Dockerfile\" %}\n```\n\nInclude the remote file (only absolute urls):\n```jinja\n{% include_file \"https://raw.githubusercontent.com/werf/werf-guides/master/examples/rails/010_build/Dockerfile\" %}\n```\n\nInclude part of the file (the part should be enclosed in `[\u003csnippet snippetname\u003e]` and `[\u003cendsnippet snippetname\u003e]`):\n```jinja\n{% include_file \"Dockerfile\" snippet=\"snippetname\" %}\n```\n\nInclude the file and wrap the result in `` ```dockerfile `` and `` ``` ``:\n```jinja\n{% include_file \"Dockerfile\" syntax=\"dockerfile\" %}\n```\n\nDynamic parameters:\n```jinja\n{% include_file \"{{ $templatingAllowedHere }}/Dockerfile\" snippet=\"{{ $hereToo }}\" %}\n```\n\n## Ignore a part of an included content\n\nThe usage:\n```jsx\nconst template = () =\u003e {\n  return (\n    // [\u003csnippet example\u003e]\n    \u003cProvider\n      // [\u003cignore\u003e]\n      propToIgnore={propToIgnore}\n      // [\u003cendignore\u003e]\n      component={() =\u003e \u003cdiv\u003eData is loading...\u003c/div\u003e}\n      errorComponent={({ message }) =\u003e \u003cdiv\u003eThere was an error: {message}\u003c/div\u003e}\n    \u003e\n      ...\n    \u003c/Provider\u003e\n    // [\u003cendsnippet example\u003e]\n  );\n};\n```\n\nThe result:\n```jsx\n  \u003cProvider\n    component={() =\u003e \u003cdiv\u003eData is loading...\u003c/div\u003e}\n    errorComponent={({ message }) =\u003e \u003cdiv\u003eThere was an error: {message}\u003c/div\u003e}\n  \u003e\n    ...\n  \u003c/Provider\u003e\n```\n\n## Plugin options in `_config.yml`\n\nDefault options:\n```yml\njekyll_include_plugin:\n  snippet_prefix: '...'\n```\n\n### `snippet_prefix`\nType: `string` Default: `...`\n\nPrepends the prefix at the end of included snippet to differentiate whole file includes vs partial file includes (snippet)  \n\n## Installation\n\nAdd this line to your application's Gemfile:\n\n```ruby\ngem 'jekyll_include_plugin'\n```\n\nAnd this into your Jekyll config:\n```yaml\nplugins:\n  - jekyll_include_plugin\n```\n\nThen execute:\n```bash\nbundle install\n```\n\n## Development\n\nAfter checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.\n\nTo install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).\n\n## License\n\nThe gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fflant%2Fjekyll_include_plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fflant%2Fjekyll_include_plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fflant%2Fjekyll_include_plugin/lists"}