{"id":17155312,"url":"https://github.com/kevinzg/sourcecodex","last_synced_at":"2025-03-24T13:43:48.111Z","repository":{"id":176680624,"uuid":"617741166","full_name":"kevinzg/sourcecodex","owner":"kevinzg","description":"A program to convert source code repos to epubs","archived":false,"fork":false,"pushed_at":"2023-03-23T02:22:12.000Z","size":7,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-01-29T18:46:57.101Z","etag":null,"topics":["epub","source-code-reading"],"latest_commit_sha":null,"homepage":"","language":"Go","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/kevinzg.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-23T02:21:16.000Z","updated_at":"2024-08-11T01:00:38.000Z","dependencies_parsed_at":null,"dependency_job_id":"443eb436-18a9-48e0-8278-f70323268fea","html_url":"https://github.com/kevinzg/sourcecodex","commit_stats":null,"previous_names":["kevinzg/sourcecodex"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kevinzg%2Fsourcecodex","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kevinzg%2Fsourcecodex/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kevinzg%2Fsourcecodex/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kevinzg%2Fsourcecodex/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kevinzg","download_url":"https://codeload.github.com/kevinzg/sourcecodex/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245284196,"owners_count":20590305,"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":["epub","source-code-reading"],"created_at":"2024-10-14T21:51:11.515Z","updated_at":"2025-03-24T13:43:48.079Z","avatar_url":"https://github.com/kevinzg.png","language":"Go","readme":"# SourceCodex\n\nA program to convert source code repos to epubs.\n\n## Features\n\n-   Syntax highlighting\n\n## Examples\n\nThe program receives as input the filenames to include:\n\n```bash\n$ fd -e go | sourcecodex\n```\n\nHere's another example with more filters and files sorted by last commit date:\n\n```bash\n$ git ls-tree -r --name-only HEAD \\\n    | grep -E '\\.ts$' \\\n    | grep -v -E '(^test|__test__|\\.test\\.\\w+$|\\.d\\.ts$)' \\\n    | xargs -I{} git log -1 --format='%at {}' -- {} \\\n    | sort -n -r \\\n    | cut -d ' ' -f2- \\\n    | sourcecodex -title \"Cool project\" -author \"Cool author\" -output \"source.epub\"\n```\n\n## To-do\n\n-   Add links between files (like a dependency graph)\n-   Add an index for symbols, with links to its definition, and references\n-   Link symbols in the code to their entry on the index\n-   Sort files with a recommended reading order\n-   Autoformat code for a better ebook reading experience\n-   Add line numbers\n-   Generate a cover\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkevinzg%2Fsourcecodex","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkevinzg%2Fsourcecodex","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkevinzg%2Fsourcecodex/lists"}