{"id":16432642,"url":"https://github.com/teles/readme-converter-action","last_synced_at":"2026-02-26T17:36:34.243Z","repository":{"id":61100301,"uuid":"548195686","full_name":"teles/readme-converter-action","owner":"teles","description":null,"archived":false,"fork":false,"pushed_at":"2024-06-02T20:34:11.000Z","size":34,"stargazers_count":1,"open_issues_count":5,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-17T10:12:21.730Z","etag":null,"topics":["hacktoberfest","hacktoberfest2023"],"latest_commit_sha":null,"homepage":"","language":"Shell","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/teles.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":"2022-10-09T04:43:18.000Z","updated_at":"2024-06-02T20:34:13.000Z","dependencies_parsed_at":"2024-01-13T14:50:09.572Z","dependency_job_id":"7dee00c4-01c5-458e-accd-3ffe395c3aec","html_url":"https://github.com/teles/readme-converter-action","commit_stats":{"total_commits":19,"total_committers":2,"mean_commits":9.5,"dds":0.1578947368421053,"last_synced_commit":"690bce5d3ad841d379a39c5389281b50b4bd7d81"},"previous_names":["teles/readme-converter-action","teles/awesome-parser-action"],"tags_count":13,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/teles%2Freadme-converter-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/teles%2Freadme-converter-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/teles%2Freadme-converter-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/teles%2Freadme-converter-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/teles","download_url":"https://codeload.github.com/teles/readme-converter-action/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245458061,"owners_count":20618693,"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":["hacktoberfest","hacktoberfest2023"],"created_at":"2024-10-11T08:43:59.017Z","updated_at":"2026-02-26T17:36:29.216Z","avatar_url":"https://github.com/teles.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Readme Converter Action\n\n![Readme Converter Logo](logo.svg \"Readme Converter Logo\")\n\nThis GitHub action reads the content of a `README.md` file from another repository and transforms it into HTML Chrome bookmarks, CSV, and JSON files. It's a useful tool for exporting link and bookmark information from a README file into other formats.\n\n## How to Use\n\nYou can use this action in a workflow in your own repository to process the `README.md` file from another repository. Below is an example of how to set up the action in a workflow configuration file `(.github/workflows/main.yml)` in your own repository:\n\n\n```yaml\non: [push]\n\njobs:\n  parse_to_bookmarks:\n    runs-on: ubuntu-latest\n    name: Export README to json, csv, and bookmarks\n    steps:\n        - uses: teles/readme-converter-action@v0.4.2\n          with:\n            input: README.md\n            output: dist/bookmarks.html\n        - uses: teles/readme-converter-action@v0.4.2\n          with:\n            type: csv\n            input: README.md\n            output: dist/links.csv\n        - uses: teles/readme-converter-action@v0.4.2\n          with:\n            type: json\n            input: README.md\n            output: dist/links.json\n            commit_branch: gh-pages\n            commit_message: Updates JSON file\n```            \n\nIn this example, the action is set up to run when a push occurs in the repository. It reads the content of the `README.md` file and generates HTML, CSV, and JSON files in a directory named `dist`. You can also customize the output type and other options as needed.\n\n### Parameters\n\n* `input`: The README.md file you want to process.\n* `output`: The name of the output file generated by the action.\n* `type` (optional): The desired output format (HTML, CSV, or JSON).\n* `commit_branch` (optional): The branch where you want to commit the `output file` (used when the type is JSON).\n* `commit_message` (optional): The commit message used when the action commits the output file.\n\nMake sure to properly configure credentials and permissions to access the repository containing the `README.md` file you want to process.\n\n## License\n\nThis project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fteles%2Freadme-converter-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fteles%2Freadme-converter-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fteles%2Freadme-converter-action/lists"}