${tocEl.result.title}
54 |${tocEl.result.content}
55 |
40 | ${content}
41 |
42 |
43 |
44 | `;
45 | };
46 |
47 | function tocObjToHtml(tocObj) {
48 | return getHtml(
49 | _.map(tocObj.content, tocEl => {
50 | if (tocEl.result) {
51 | return `
52 | ${tocEl.title}
`; 60 | if (tocEl.level === 1) return `${tocEl.title}
`; 61 | 62 | return ''; 63 | }).join('') 64 | ); 65 | } 66 | 67 | module.exports = tocObjToHtml; 68 | -------------------------------------------------------------------------------- /src/strategies/angular2/scrapper.js: -------------------------------------------------------------------------------- 1 | const _ = require('lodash') 2 | 3 | const cheerio = require('cheerio') 4 | const axios = require('axios') 5 | const url = require('url') 6 | 7 | const CONFIG = require('./index.js') 8 | 9 | const DOCURL = 'https://angular.io/docs/ts/latest/quickstart.html' 10 | 11 | function strategy () { 12 | return new Promise(function (resolve, reject) { 13 | axios.get(DOCURL) 14 | .then(res => { 15 | var $ = cheerio.load(res.data) 16 | var tocArray = [] 17 | 18 | $('.nav-blocks').each(function (index, el) { 19 | var parentName = $(el).find('nav-title').first().text() 20 | 21 | if (parentName === 'API Reference') return 22 | 23 | tocArray.push({ 24 | title: parentName, 25 | level: 1 26 | }) 27 | 28 | $(this).find('.nav-unordered-lists a').each(function (childIndex, childEl) { 29 | tocArray.push({ 30 | parent: parentName, 31 | level: 2, 32 | title: $(childEl).text(), 33 | url: url.resolve(DOCURL, $(childEl).attr('href')) 34 | }) 35 | }) 36 | 37 | $(this).find('.nav-ordered-lists a').each(function (childIndex, childEl) { 38 | tocArray.push({ 39 | parent: parentName, 40 | level: 2, 41 | title: $(childEl).text(), 42 | url: url.resolve(DOCURL, $(childEl).attr('href')) 43 | }) 44 | }) 45 | }) 46 | 47 | resolve( 48 | _.assign({}, CONFIG, { 49 | content: tocArray 50 | }) 51 | ) 52 | }) 53 | }) 54 | } 55 | 56 | module.exports = strategy 57 | -------------------------------------------------------------------------------- /src/strategies/sass/scrapperMd.js: -------------------------------------------------------------------------------- 1 | const axios = require('axios') 2 | const _ = require('lodash') 3 | const async = require('async') 4 | 5 | const CONFIG = require('./index.js') 6 | 7 | var docList = [{ 8 | title: 'Sass reference', 9 | url: 'https://raw.githubusercontent.com/sass/sass/stable/doc-src/SASS_REFERENCE.md' 10 | }, { 11 | title: 'Indented syntax', 12 | url: 'https://raw.githubusercontent.com/sass/sass/stable/doc-src/INDENTED_SYNTAX.md' 13 | }, { 14 | title: 'SCSS for SASS Users', 15 | url: 'https://raw.githubusercontent.com/sass/sass/stable/doc-src/SCSS_FOR_SASS_USERS.md' 16 | }, { 17 | title: 'FAQ', 18 | url: 'https://raw.githubusercontent.com/sass/sass/stable/doc-src/FAQ.md' 19 | }, { 20 | title: 'Changelog', 21 | url: 'https://raw.githubusercontent.com/sass/sass/stable/doc-src/SASS_CHANGELOG.md' 22 | }] 23 | 24 | docList = _.map(docList, (el, idx) => { 25 | el.index = ('000' + idx).slice(-3) 26 | return el 27 | }) 28 | 29 | function requestUrl (doc, cb) { 30 | axios.get(doc.url).then(res => { 31 | console.log('READED', doc.url) 32 | cb(null, _.assign({}, doc, { 33 | result: { 34 | title: doc.title, 35 | content: res.data 36 | } 37 | })) 38 | }, (err) => { 39 | cb(err) 40 | }) 41 | } 42 | 43 | function strategy () { 44 | return new Promise(function (resolve, reject) { 45 | async.map(docList, requestUrl, function (asyncErr, asyncRes) { 46 | if (asyncErr) { 47 | reject(asyncErr) 48 | return 49 | } 50 | 51 | resolve( 52 | _.assign({}, CONFIG, { 53 | content: asyncRes 54 | }) 55 | ) 56 | }) 57 | }) 58 | } 59 | 60 | module.exports = strategy 61 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | Get your favorite docs as ebooks! 2 | Doc scraper and ebook generator. 3 | 4 | [](http://javier.xyz/docs2epub/) 5 | 6 | # Library 7 | List of precompiled ebooks created with docs2epub. 8 | 9 | * React [[epub]](http://javier.xyz/docs2epub/download/react.epub) [stable] 10 | * Lodash [[epub]](http://javier.xyz/docs2epub/download/lodash.epub) [stable] 11 | * Sass [[epub]](http://javier.xyz/docs2epub/download/sass.epub) [beta] 12 | * Underscore [[epub]](http://javier.xyz/docs2epub/download/underscore.epub) [beta] 13 | * express [[epub]](http://javier.xyz/docs2epub/download/express.epub) [beta] 14 | * angular2 [[epub]](http://javier.xyz/docs2epub/download/angular2.epub) [alpha] 15 | 16 | # Generate your own ebook form docs 17 | The objective of this tool is to be a ready to go documentation parser and ebook generator (from scraping documentation sites or markdown). 18 | 19 | It has a central processing and epub generator based on [strategies](https://github.com/javierbyte/docs2epub/tree/master/src/strategies). 20 | 21 | If you want to add your own ebook generator you'll have to add a 'strategy' to the the `/src/strategies/` dir that returns a `docObj` object as described on [tocToArray.js](https://github.com/javierbyte/docs2epub/blob/master/src/tocToArray.js). And then require it on [run.js](https://github.com/javierbyte/docs2epub/blob/master/src/run.js#L3). 22 | 23 | Then run 24 | ``` 25 | node index.js --project
45 |
46 |
43 |
47 |
115 |
48 |
50 | Library
49 |
51 |
59 |
60 |
68 |
69 |
77 |
78 |
86 |
87 |
95 |
96 |
104 |
105 |
113 |
114 | 115 |
116 |
132 |
117 |
130 |
118 |
121 | stable
119 | You may not be able to tell that this was scrapped from a website!
120 |
122 |
125 | beta
123 | Probably not everything looks pretty, but you should be able to understand the complete docs.
124 |
126 |
129 | alpha
127 | Some stuff may not be present, or not be understandable at all.
128 | Don't see your favorite library? generate your own or open an issue.
131 |
135 |
136 |
163 |
137 |
139 |
140 |
141 |
146 | Want to know about new ebooks?
138 |
147 |
156 |
157 |
158 |
159 |
160 | Max one email per week, promise 🙌
161 |
162 |