mirror of
https://github.com/whoisclebs/lodash.git
synced 2026-02-11 03:17:49 +00:00
Add doc-site build script (#2461)
This commit is contained in:
committed by
John-David Dalton
parent
a64b629333
commit
6b0069f10f
1
.gitignore
vendored
1
.gitignore
vendored
@@ -2,3 +2,4 @@
|
|||||||
*.log
|
*.log
|
||||||
coverage
|
coverage
|
||||||
node_modules
|
node_modules
|
||||||
|
doc/*.html
|
||||||
43
lib/main/build-site.js
Normal file
43
lib/main/build-site.js
Normal file
@@ -0,0 +1,43 @@
|
|||||||
|
'use strict';
|
||||||
|
|
||||||
|
const fs = require('fs'),
|
||||||
|
marky = require('marky-markdown'),
|
||||||
|
path = require('path'),
|
||||||
|
_ = require('lodash');
|
||||||
|
|
||||||
|
const basePath = path.join(__dirname, '..', '..'),
|
||||||
|
docPath = path.join(basePath, 'doc'),
|
||||||
|
readmePath = path.join(docPath, 'README.md');
|
||||||
|
|
||||||
|
function onComplete(error) {
|
||||||
|
if (error) {
|
||||||
|
throw error;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function build(type) {
|
||||||
|
let html =
|
||||||
|
marky(fs.readFileSync(readmePath, 'utf8'), { sanitize: false });
|
||||||
|
const header = html('h1').first();
|
||||||
|
const version = _.trim(header.find('span').first().text());
|
||||||
|
|
||||||
|
header.remove();
|
||||||
|
html = html.html();
|
||||||
|
html = html.replace(/<!--\s*/g, '<');
|
||||||
|
html = html.replace(/-->/g, '>');
|
||||||
|
|
||||||
|
html = [
|
||||||
|
'---',
|
||||||
|
'id: docs',
|
||||||
|
'layout: docs',
|
||||||
|
'title: lodash Documentation',
|
||||||
|
`version: ${version ? version : null}`,
|
||||||
|
'---',
|
||||||
|
html,
|
||||||
|
].join('\n');
|
||||||
|
|
||||||
|
// File output
|
||||||
|
fs.writeFile(path.join(docPath, `${version}.html`), html, onComplete);
|
||||||
|
}
|
||||||
|
|
||||||
|
build();
|
||||||
@@ -13,6 +13,7 @@
|
|||||||
"doc": "node lib/main/build-doc github && npm run test:doc",
|
"doc": "node lib/main/build-doc github && npm run test:doc",
|
||||||
"doc:fp": "node lib/fp/build-doc",
|
"doc:fp": "node lib/fp/build-doc",
|
||||||
"doc:site": "node lib/main/build-doc site",
|
"doc:site": "node lib/main/build-doc site",
|
||||||
|
"doc:sitehtml": "npm run doc:site && node lib/main/build-site",
|
||||||
"prepublish": "npm run build",
|
"prepublish": "npm run build",
|
||||||
"pretest": "npm run build",
|
"pretest": "npm run build",
|
||||||
"style": "npm run style:main && npm run style:fp && npm run style:perf && npm run style:test",
|
"style": "npm run style:main && npm run style:fp && npm run style:perf && npm run style:test",
|
||||||
@@ -43,6 +44,7 @@
|
|||||||
"jscs": "^3.0.5",
|
"jscs": "^3.0.5",
|
||||||
"lodash": "4.11.2",
|
"lodash": "4.11.2",
|
||||||
"markdown-doctest": "^0.8.1",
|
"markdown-doctest": "^0.8.1",
|
||||||
|
"marky-markdown": "^7.0.1",
|
||||||
"platform": "^1.3.1",
|
"platform": "^1.3.1",
|
||||||
"qunit-extras": "^2.0.1",
|
"qunit-extras": "^2.0.1",
|
||||||
"qunitjs": "^1.23.1",
|
"qunitjs": "^1.23.1",
|
||||||
|
|||||||
Reference in New Issue
Block a user