Skip to content

Converts README's into DeveHelp2 books

License

Notifications You must be signed in to change notification settings

gutierri/read2devhelp

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

read2devhelp: Converts README's into DeveHelp2 books

https://travis-ci.org/gutierri/read2devhelp.svg?branch=master Code style: pep8

Python Version: 3.6+

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:

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

or save read2devhelp.py on $PATH:

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

Usage

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?)

About

Converts README's into DeveHelp2 books

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published