FilesExpand file tree

 main

/

ebooks

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

executable file

·

196 lines (173 loc) · 5.54 KB

 main

/

ebooks

Copy path

Top

File metadata and controls

• Code
• Blame

executable file

·

196 lines (173 loc) · 5.54 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

84

85

86

87

88

89

90

91

92

93

94

95

96

97

98

99

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

#!/usr/bin/env node

// Generate EPUB and MOBI ebooks

const fs = require('fs');

const path = require('path');

const exec = require('child_process').exec;

const fastmatter = require('fastmatter');

const mkdirp = require('mkdirp');

const slug = require('slug');

const unified = require('unified');

const parse = require('remark-parse');

const stringify = require('remark-stringify');

const visit = require('unist-util-visit');

const download = require('download');

const ebrew = require('ebrew');

const processor = unified()

.use(parse)

.use(replaceAsides)

.use(replaceCheckboxes)

.use(fixImages)

.use(downloadImages)

.use(stringify);

buildBooks([

'_articles/how-to-contribute.md',

'_articles/starting-a-project.md',

'_articles/finding-users.md',

'_articles/building-community.md',

'_articles/best-practices.md',

'_articles/leadership-and-governance.md',

'_articles/getting-paid.md',

'_articles/code-of-conduct.md',

'_articles/metrics.md',

'_articles/legal.md',

]);

function buildBooks(files) {

const out = 'assets/ebooks/open-source-guide';

const tempFile = '_ebook.md';

mkdirp.sync('assets/ebooks');

mkdirp.sync('.asset-downloads');

let source = files.map(readFile).join('\n\n');

const { text, promises } = downloadImages(source);

fs.writeFileSync(tempFile, text);

promises

.then(() => markdownToEpub(tempFile, `${out}.epub`))

.then(() => epubToMobi(`${out}.epub`, `${out}.mobi`))

.then(() => fs.unlinkSync(tempFile))

.catch(err => console.error(err));

}

function readFile(file) {

const md = fs.readFileSync(file, 'utf8');

// Replace frontmatter with chapter title

const { attributes, body } = fastmatter(md);

let text = `# ${attributes.title}\n\n${body}`;

return processor.process(text).contents;

}

function markdownToEpub(mdFile, epubFile) {

return new Promise((resolve, reject) => {

console.log(`Building ${epubFile}...`);

const manifestFile = '_ebook.json';

fs.writeFileSync(manifestFile, JSON.stringify({

tocDepth: 1,

title: 'Open Source Guides',

subtitle: 'Open source software is made by people just like you. Learn how to launch and grow your project.',

author: 'GitHub',

publisher: 'GitHub',

rights: 'CC-BY-4.0',

date: (new Date()).toISOString().slice(0, 10),

contents: path.resolve(mdFile),

}));

ebrew.generate(manifestFile, epubFile, err => {

fs.unlinkSync(manifestFile);

if (err) {

reject(err.stack || err);

} else {

resolve();

}

});

});

}

function epubToMobi(epubFile, mobiFile) {

return new Promise((resolve, reject) => {

console.log(`Building ${mobiFile}...`);

const kindlegen = require.resolve('kindlegen/bin/kindlegen');

exec(`${kindlegen} ${epubFile} -c2 -verbose -o ${path.basename(mobiFile)}`, (err, stdout) => {

if (err && stdout.includes('MOBI file could not be generated because of errors!')) {

reject(stdout);

} else {

resolve();

}

});

});

}

function downloadImages(text) {

function image(processor) {

return ast => visit(ast, 'image', node => {

if (node.url.startsWith('http')) {

const url = node.url;

const filename = slug(path.basename(node.url));

const filepath = `./.asset-downloads/${filename}.jpg`

node.url = filepath;

if (fs.existsSync(filepath)) {

promises.push(Promise.resolve());

} else {

const promise = download(url)

.then(data => {

fs.writeFileSync(filepath, data);

});

promises.push(promise);

}

}

});

}

let promises = [];

const processor = unified()

.use(parse)

.use(image)

.use(stringify);

text = processor.process(text).contents;

return {

promises: Promise.all(promises),

text,

};

}

/*

Replace asides with Markdown blockquotes:

<aside markdown="1" class="pquote">

<img src="https://avatars2.githubusercontent.com/u/1976330?v=3&s=460" class="pquote-avatar" alt="avatar" alt="@lord avatar">

I fumbled it. I didn't put in the effort to come up with a complete solution. Instead of an half-assed solution, I wish I had said "I don't have time for this right now, but I'll add it to the long term nice-to-have list."

<p markdown="1" class="pquote-credit">

— @lord, ["Tips for new open source maintainers"](https://lord.io/blog/2014/oss-tips/)

</p>

</aside>

*/

function replaceAsides(processor) {

return ast => visit(ast, 'html', node => {

if (node.value.startsWith('<aside')) {

node.value = node.value

.replace(/ <img src="(.*?)"[^>]*>/, '\n')

.replace(/\(\/assets\//, '(./assets/')

.replace(/<\/?(aside|p).*?>/g, '')

.trim()

.replace(/(^|\n) */g, '\n> ');

}

});

}

/*

Replace checkboxes with unordered lists:

<div class="clearfix mb-2">

<input type="checkbox" id="cbox1" class="d-block float-left mt-1 mr-2" value="checkbox">

<label for="cbox1" class="overflow-hidden d-block text-normal">

Does it have a license? Usually, this is a file called LICENSE in the root of the repository.

</label>

</div>

*/

function replaceCheckboxes(processor) {

return ast => visit(ast, 'html', node => {

if (node.value.startsWith('<div')) {

node.value = node.value

.replace(/<\/?.*?>/g, '')

.trim()

.replace(/^/, '* ');

}

});

}

/*

1. Remove image alts, otherwise they will be visible in a book

2. Fix asset paths

*/

function fixImages(processor) {

return ast => visit(ast, 'image', node => {

node.alt = null;

node.url = node.url.replace(/^\/assets\//, './assets/');

});

}