@mintlify/scraping
Version:
Scrape documentation frameworks to Mintlify docs
66 lines • 2.72 kB
JavaScript
import { visit, EXIT, CONTINUE } from 'unist-util-visit';
import { log } from './log.js';
export const framework = {
vendor: undefined,
version: undefined,
};
export function detectFramework(rootHast) {
visit(rootHast, 'element', function (node) {
const { content: rawContent, rel, name, href } = node.properties;
const content = (Array.isArray(rawContent) ? rawContent.join(' ') : String(rawContent)).toLowerCase();
if ((node.tagName === 'link' &&
Array.isArray(rel) &&
rel.includes('preconnect') &&
href === 'https://api.gitbook.com') ||
(node.tagName === 'link' &&
Array.isArray(rel) &&
rel.includes('preconnect') &&
href === 'https://api.gitbook.com/cache') ||
(node.tagName === 'meta' && name === 'generator' && content.includes('gitbook'))) {
framework.vendor = 'gitbook';
framework.version = undefined;
return EXIT;
}
// All of the other docs vendors rely on
// the `meta` element as well as a `name`
// property which should be a string
if (node.tagName !== 'meta' || typeof name !== 'string')
return CONTINUE;
switch (name) {
case 'readme-deploy':
framework.vendor = 'readme';
framework.version = undefined;
return EXIT;
// case "intercom: trackingEvent":
// framework.vendor = "intercom";
// framework.version = undefined;
// return EXIT;
case 'generator':
if (content.includes('docusaurus')) {
framework.vendor = 'docusaurus';
const meta = content;
if (meta.includes('v3')) {
framework.version = 3;
}
else if (meta.includes('v2')) {
framework.version = 2;
}
else if (meta.includes('v1')) {
log('We detected Docusaurus version 1 but we only support scraping versions 2 and 3', 'error');
framework.vendor = undefined;
framework.version = undefined;
}
return EXIT;
}
}
});
if (framework.vendor) {
log('Successfully detected documentation vendor: ' + framework.vendor);
}
else {
log('Failed to detect documentation vendor; please contact support@mintlify.com');
framework.version = undefined;
process.exit(1);
}
}
//# sourceMappingURL=detectFramework.js.map