https://github.com/gutierri/read2devhelp

Converts README's into DeveHelp2 books
https://github.com/gutierri/read2devhelp

devhelp docs gnome readme

Last synced: 8 days ago
JSON representation

Converts README's into DeveHelp2 books

• Host: GitHub
• URL: https://github.com/gutierri/read2devhelp
• Owner: gutierri
• License: gpl-3.0
• Created: 2019-03-03T23:38:18.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2019-07-08T00:21:41.000Z (over 5 years ago)
• Last Synced: 2023-10-23T20:24:37.971Z (about 1 year ago)
• Topics: devhelp, docs, gnome, readme
• Language: Python
• Homepage:
• Size: 17.6 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
###################################################

read2devhelp: Converts README's into DeveHelp2 books

###################################################

.. image:: https://travis-ci.org/gutierri/read2devhelp.svg?branch=master

   :target: https://travis-ci.org/gutierri/read2devhelp

.. image:: https://img.shields.io/badge/code%20style-pep8-blue.svg

   :target: https://www.python.org/dev/peps/pep-0008/

   :alt: Code style: pep8

.. image:: https://img.shields.io/badge/python-3.6-blue.svg

   :alt: Python Version: 3.6+

.. image:: https://img.shields.io/badge/dependencies-any-blue.svg

   :alt: Dependencies: Any

---------------

``read2devhelp`` leaves easy access to README~DOCS (e.g. `Axios

`_ JS lib), where in the library README contains necessary information that need or could be accessed offline in a structured way in `Gnome DevHelp

`_.

Goodbye several tabs!

**********

Installing

**********

Via pip with git:

.. code-block:: shell

  pip3 install --user git+https://github.com/gutierri/read2devhelp.git

or save ``read2devhelp.py`` on $PATH:

.. code-block:: shell

   curl -o $HOME/.local/bin/read2devhelp https://raw.githubusercontent.com/gutierri/read2devhelp/master/read2devhelp.py

.. code-block:: shell

   chmod +x $HOME/.local/bin/read2devhelp

*****

Usage

*****

.. code-block:: shell

  read2devhelp https://github.com/axios/axios

Now just open DevHelp and the book will be there!

****

TODO

****

- Improve tag "code/pre" format code

- Support others services (e.g. gitlab, gogs, gitea, bitbucket)

- Cache images on disk

- Improve information about the book, language, author... (via command line options?)