Dark Mode

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

kamidox/html2Dash

Folders and files

NameName
Last commit message
Last commit date

Latest commit

History

12 Commits

Repository files navigation

Guan Yu

Sheng Cheng Dash Ge Shi De Wei Xin Xiao Cheng Xu De Chi Xian Wen Dang .

Zhi Jie Shi Yong

Xia Zai Wo Bian Yi Hao De minapp.docset ,Tian Jia Dao Dash Li Ji Ke . Ru Guo Ni Bu Zhi Dao Dash Shi Shi Yao ,Qu Liao Jie Yi Xia Jue Dui Zhuan Dao . Zai Linux/Windows Xia Ye You Xiang Ying De Ti Dai Pin . Zai Ci Bu Zhui Shu .

Zi Ji Sheng Cheng Wei Xin Xiao Cheng Xu Chi Xian Wen Dang

Bu Zou Yi :Xia Zai Wei Xin Xiao Cheng Xu Wen Dang

Wo Men Shi Yong wget Ba Wei Xin Xiao Cheng Xu De Kai Fa Wen Dang Quan Bu Xia Zai Xia Lai .

$ mkdir -p ~/temp/wxadoc
$ cd ~/temp/wxadoc
$ wget -r -p -k -np https://mp.weixin.qq.com/debug/wxadoc/dev/

Cheng Gong Xia Zai Hou De Mu Lu Shu Da Gai Chang Zhe Yang Zi :

$ tree -L 2
.
+-- dev
| +-- api
| +-- component
| +-- demo
| +-- demo.html
| +-- demo.html?t=2017117.html
| +-- devtools
| +-- framework
| +-- image
| +-- index.html
| +-- index.html?t=2017117.html
| +-- index.html?t=2017119.html
| +-- qa.html
| +-- qa.html?t=2017117.html
+-- gitbook
+-- fonts
+-- gitbook-plugin-highlight
+-- gitbook-plugin-lunr
+-- gitbook-plugin-search
+-- gitbook.js?t=2017117
+-- gitbook.js?t=2017119
+-- images
+-- style.css?t=2017117.css
+-- style.css?t=2017119.css
+-- theme.js?t=2017117
+-- theme.js?t=2017119

13 directories, 13 files

Bu Zou Er :Zhuan Huan Cheng Dash Ge Shi De docset

$ python html2dash.py -n minapp -d ./ -i ~/temp/wxadoc/mp.weixin.qq.com/debug/wxadoc/gitbook/images/icon_note_logo@2x.png -p wxadoc/dev/framework/MINA.html ~/temp/wxadoc/mp.weixin.qq.com/debug/wxadoc

Create the Docset Folder!
Copy the HTML Documentation!
Create the SQLite Index
Create the Info.plist File
Create the Icon for the Docset!
Generate Docset Successfully!

Yun Xing Zhi Qian Xu Yao An Zhuang Python,Ling Wai Huan Xu Yao An Zhuang beautifulsoap4.

$ pip install beautifulsoup4==4.3.2

Yun Xing Cheng Gong Hou ,Hui Zai Dang Qian Mu Lu Sheng Cheng minapp.docset Mu Lu . Zhi Jie Dao Ru Dash Ji Ke Shi Yong .


Qi Ta Wen Dang

LightGBM

$ mkdir LightGBM
$ cd LightGBM
$ wget -r -p -k -np http://lightgbm.readthedocs.io/en/latest/index.html
$ source .venb/bin/activate
$ python html2dash.py -n LightGBM -d ./ LightGBM/lightgbm.readthedocs.io/en/latest

Zhi Hou Hui Sheng Cheng LightGBM.docset,Da Kai LightGBM.docset/Contents/info.plist,Xiu Gai index.html Wei latest/index.html Ji Ke .


html2Dash

html2Dash is an Documentation Set generator intended to be used with the Dash.app API browser for OS X or one of its many clones. html2Dash is just like doc2dash but generating docset from any HTML documentations.

If you've never heard of Dash.app, you're missing out: together with html2Dash it's all your API documentation at your fingertips!

Third part library required:

beautifulsoup4==4.3.2

It's tested on Python 2.7, OS X 10.9.

How to Use

The usage is as simple as:

$ html2Dash

html2dash will create a new directory called .docset in ~/Library/Application Support/html2dash/DocSets containing a Dash.app-compatible docset. When finished, the docset is automatically added to Dash.app.

Options and Arguments

The full usage is:

$ doc2dash [OPTIONS] SOURCE

The SOURCE is a directory containing the HTML documents you would like to convert.

Valid OPTIONS are the following:

  • -n, --name

    Name the docset explicitly instead of letting doc2dash guess the correct name from the directory name of the source.

  • -d PATH, --destination PATH

    Put the resulting docset into PATH. Default is the directory ~/Library/Application Support/html2dash/DocSets

  • -i FILENAME, --icon FILENAME

    Add PNG icon FILENAME to docset that is used within Dash.app to represent the docset.

  • -p INDEX_PAGE, --index-page INDEX_PAGE

    Set the file that is shown when the docset is clicked within Dash.app.

  • -h, --help

    Show a brief usage summary and exit.

DEPENDENCIES:

  • BeautifulSoup HTML parsing library

Demo

Generate the Docset for requests: requests.docset. Command:

$ ./html2dash.py -n requests -i ~/Documents/requests-sidebar.png ~/Documents/requests
Create the Docset Folder!
Copy the HTML Documentation!
Create the SQLite Index
Create the Info.plist File
Create the Icon for the Docset!
Generate Docset Successfully!

About

Generate a docset from any HTML documentations. Written in python

Topics

Resources

Readme

Stars

Watchers

Forks

Packages

Contributors

Languages

  • Python 100.0%