Skip to content

Commit d9f2d43

Browse files
committed
docs: Pivot config
1 parent 09fc850 commit d9f2d43

File tree

3 files changed

+66
-308
lines changed

3 files changed

+66
-308
lines changed

docs-gen/template/publish.js

+15-3
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ const inflection = require('inflection');
44

55
let knownClassNames = [];
66

7-
const anchorName = (link) => inflection.dasherize(inflection.underscore(link));
7+
const anchorName = (link) => inflection.dasherize(inflection.underscore(link.replace(/#/g, '-')));
88

99
const resolveInlineLinks = str => {
1010
return inline.replaceInlineTags(str, {
@@ -25,13 +25,25 @@ const renderLinks = (p) => {
2525
return p;
2626
};
2727

28+
function generateParams(doclet) {
29+
const params = doclet.params.map(
30+
p => {
31+
const optional = p.optional ? `**Optional**` : null;
32+
const defaultValue = p.defaultvalue ? `**Default:** \`${p.defaultvalue}\`` : null;
33+
const options = [optional, defaultValue].filter(f => !!f);
34+
return `- \`${p.name}\`${options.length ? ` (${options.join(', ')})` : ''}${p.description ? ` - ${resolveInlineLinks(p.description)}` : ''}`;
35+
}
36+
);
37+
return `**Parameters:**\n\n${params.join('\n')}\n`;
38+
}
39+
2840
const generateFunctionDocletSection = (doclet) => {
2941
const title = doclet.name;
3042
const header = `##${doclet.longname.indexOf('#') !== -1 ? '#' : ''} ${title}\n`;
3143
const signature = `\`${doclet.meta.code.name || doclet.name}(${doclet.params && doclet.params.filter(p => p.name.indexOf('.') === -1).map(p => p.name).join(', ') || ''})\`\n`;
32-
const params = doclet.params ? `**Parameters:**\n\n${doclet.params.map(p => `- \`${p.name}\`${p.description ? ` - ${p.description}` : ''}`).join('\n')}\n` : ``;
44+
const params = doclet.params ? generateParams(doclet) : ``;
3345
const returns = doclet.returns ? `**Returns:** ${doclet.returns.map(p => `${p.type ? renderLinks(p) : ''}${p.description ? ` ${resolveInlineLinks(p.description)}` : ''}`)}` : ``;
34-
return [header, signature, `${doclet.description}\n`, params, returns, '\n'].join('\n');
46+
return [header, signature, `${resolveInlineLinks(doclet.description)}\n`, params, returns, '\n'].join('\n');
3547
};
3648

3749
const generateClassSection = (doclet) => {

docs/Cube.js-Frontend/@cubejs-client-core.md

-300
This file was deleted.

0 commit comments

Comments
 (0)