{"id":19755851,"url":"https://github.com/gutierri/read2devhelp","last_synced_at":"2025-02-28T01:49:37.764Z","repository":{"id":203163283,"uuid":"173643385","full_name":"gutierri/read2devhelp","owner":"gutierri","description":"Converts README's into DeveHelp2 books","archived":false,"fork":false,"pushed_at":"2024-04-18T03:21:34.000Z","size":20,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-01-10T22:29:18.988Z","etag":null,"topics":["devhelp","docs","gnome","readme"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/gutierri.png","metadata":{"files":{"readme":"README.rst","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}},"created_at":"2019-03-03T23:38:18.000Z","updated_at":"2023-05-08T08:14:20.000Z","dependencies_parsed_at":null,"dependency_job_id":"e78c4a2b-bcbe-4968-a490-6ed9308d78b7","html_url":"https://github.com/gutierri/read2devhelp","commit_stats":null,"previous_names":["gutierri/read2devhelp"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gutierri%2Fread2devhelp","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gutierri%2Fread2devhelp/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gutierri%2Fread2devhelp/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gutierri%2Fread2devhelp/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gutierri","download_url":"https://codeload.github.com/gutierri/read2devhelp/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241086574,"owners_count":19907298,"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":["devhelp","docs","gnome","readme"],"created_at":"2024-11-12T03:13:42.340Z","updated_at":"2025-02-28T01:49:37.735Z","avatar_url":"https://github.com/gutierri.png","language":"Python","readme":"###################################################\nread2devhelp: Converts README's into DeveHelp2 books\n###################################################\n\n.. image:: https://travis-ci.org/gutierri/read2devhelp.svg?branch=master\n   :target: https://travis-ci.org/gutierri/read2devhelp\n\n.. image:: https://img.shields.io/badge/code%20style-pep8-blue.svg\n   :target: https://www.python.org/dev/peps/pep-0008/\n   :alt: Code style: pep8\n\n.. image:: https://img.shields.io/badge/python-3.6-blue.svg\n   :alt: Python Version: 3.6+\n\n.. image:: https://img.shields.io/badge/dependencies-any-blue.svg\n   :alt: Dependencies: Any\n\n---------------\n\n``read2devhelp`` leaves easy access to README~DOCS (e.g. `Axios\n\u003chttps://github.com/axios/axios/\u003e`_ JS lib), where in the library README contains necessary information that need or could be accessed offline in a structured way in `Gnome DevHelp\n\u003chttps://wiki.gnome.org/Apps/Devhelp\u003e`_.\n\nGoodbye several tabs!\n\n\n**********\nInstalling\n**********\n\nVia pip with git:\n\n.. code-block:: shell\n\n  pip3 install --user git+https://github.com/gutierri/read2devhelp.git\n\nor save ``read2devhelp.py`` on $PATH:\n\n.. code-block:: shell\n\n   curl -o $HOME/.local/bin/read2devhelp https://raw.githubusercontent.com/gutierri/read2devhelp/master/read2devhelp.py\n\n.. code-block:: shell\n\n   chmod +x $HOME/.local/bin/read2devhelp\n\n*****\nUsage\n*****\n\n.. code-block:: shell\n\n  read2devhelp https://github.com/axios/axios\n\nNow just open DevHelp and the book will be there!\n\n****\nTODO\n****\n\n- Improve tag \"code/pre\" format code\n- Support others services (e.g. gitlab, gogs, gitea, bitbucket)\n- Cache images on disk\n- Improve information about the book, language, author... (via command line options?)\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgutierri%2Fread2devhelp","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgutierri%2Fread2devhelp","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgutierri%2Fread2devhelp/lists"}