{"id":16162094,"url":"https://github.com/peterdavehello/docker-doctoc","last_synced_at":"2025-03-18T22:30:56.280Z","repository":{"id":41050181,"uuid":"83348911","full_name":"PeterDaveHello/docker-doctoc","owner":"PeterDaveHello","description":"Pack npm package \"doctoc\" into a docker image","archived":false,"fork":false,"pushed_at":"2024-12-07T16:05:27.000Z","size":10,"stargazers_count":13,"open_issues_count":1,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-17T00:07:44.219Z","etag":null,"topics":["docker","docker-image","doctoc","hacktoberfest","markdown","readme","table-of-contents","table-of-contents-generator"],"latest_commit_sha":null,"homepage":"https://hub.docker.com/r/peterdavehello/npm-doctoc","language":"Dockerfile","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/PeterDaveHello.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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":"2017-02-27T19:36:08.000Z","updated_at":"2025-03-02T15:12:59.000Z","dependencies_parsed_at":"2023-01-19T21:33:02.175Z","dependency_job_id":"7a0d751b-bc81-4097-a77a-074c1707f74d","html_url":"https://github.com/PeterDaveHello/docker-doctoc","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/PeterDaveHello%2Fdocker-doctoc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PeterDaveHello%2Fdocker-doctoc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PeterDaveHello%2Fdocker-doctoc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PeterDaveHello%2Fdocker-doctoc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/PeterDaveHello","download_url":"https://codeload.github.com/PeterDaveHello/docker-doctoc/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244318437,"owners_count":20433903,"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":["docker","docker-image","doctoc","hacktoberfest","markdown","readme","table-of-contents","table-of-contents-generator"],"created_at":"2024-10-10T02:29:03.247Z","updated_at":"2025-03-18T22:30:55.982Z","avatar_url":"https://github.com/PeterDaveHello.png","language":"Dockerfile","funding_links":[],"categories":[],"sub_categories":[],"readme":"# docker-doctoc\n\n![License](https://img.shields.io/badge/license-GPLv3.0-brightgreen.svg?style=flat)\n[![Docker Hub Pulls](https://img.shields.io/docker/pulls/peterdavehello/npm-doctoc.svg)](https://hub.docker.com/r/peterdavehello/npm-doctoc/)\n\n[![Docker Hub Badge](https://dockeri.co/image/peterdavehello/npm-doctoc)](https://hub.docker.com/r/peterdavehello/npm-doctoc/)\n\nThis Docker image packages the npm package [doctoc](https://github.com/thlorenz/doctoc), which generates a table of contents for Markdown files inside a local git repository. The generated links are compatible with anchors produced by GitHub and other platforms, thanks to a command line flag.\n\nGitHub Repository:\n\n- \u003chttps://github.com/PeterDaveHello/docker-doctoc\u003e\n\nDocker Hub Repository:\n\n- \u003chttps://hub.docker.com/r/peterdavehello/npm-doctoc/\u003e\n\n## Basic Docker Usage\n\nUse the following command to generate a table of contents for a specific Markdown file with the Docker image:\n\n```sh\ndocker run --rm -v \"$(pwd)\":/app peterdavehello/npm-doctoc doctoc /app/README.md\n```\n\nReplace `README.md` with the path to your Markdown file. This command mounts the current directory to the `/app` folder inside the container and runs `doctoc` on the specified file. Docker will automatically pull the image if it's not already available locally.\n\n## Basic doctoc Command Parameters\n\nHere are some basic `doctoc` command parameters for your reference:\n\n- `--github` (default): Generate GitHub-compatible links.\n- `--bitbucket`: Generate Bitbucket-compatible links.\n- `--gitlab`: Generate GitLab-compatible links.\n- `--stdout`: Print the generated table of contents to stdout instead of updating the file.\n\nFor more details and usage instructions, visit the `doctoc` homepage: \u003chttps://github.com/thlorenz/doctoc\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpeterdavehello%2Fdocker-doctoc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpeterdavehello%2Fdocker-doctoc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpeterdavehello%2Fdocker-doctoc/lists"}