Skip to content

Update yeoman docs generator #5401

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
cchaos merged 4 commits into from
Nov 22, 2021
Merged

Update yeoman docs generator #5401

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f4c4fa0
Update yeoman docs generator
Nov 22, 2021
313005a
Update import path in demo file
Nov 22, 2021
5daddf3
Move `text` to just below `title`
Nov 22, 2021
d8a9e78
Added `intro` to new page
Nov 22, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 13 additions & 19 deletions generator-eui/documentation/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,6 +128,7 @@ module.exports = class extends Generator {
const {
componentExampleName,
componentExamplePrefix,
componentName,
fileName,
} = this.config.documentationVars;

Expand All @@ -140,30 +141,23 @@ module.exports = class extends Generator {
'const'
)} ${componentExamplePrefix}Source = require(${chalk.cyan(
`'!!raw-loader!./${fileName}'`
)});\n` +
`${chalk.magenta(
'const'
)} ${componentExamplePrefix}Html = renderToHtml(${componentExampleName});`
)});`
);

this.log(chalk.white('\n// Render demo.'));
this.log(chalk.white('\n// Append to existing example sections.'));
this.log(
'<GuideSection\n' +
` title="${componentExampleName}"\n` +
' source={[{\n' +
'{\n' +
` title: '${componentExampleName}',\n` +
' text: (\n' +
` <><p>Description needed: how to use the <strong>${componentExampleName}</strong> component.</p></>\n` +
' ),\n' +
' source: [{\n' +
' type: GuideSectionTypes.JS,\n' +
` code: ${componentExamplePrefix}Source,\n` +
' }, {\n' +
' type: GuideSectionTypes.HTML,\n' +
` code: ${componentExamplePrefix}Html,\n` +
' }]}\n' +
' text={\n' +
` <p>Description needed: how to use the ${componentExampleName} component.</p>\n` +
' }\n' +
' demo={\n' +
` <${componentExampleName} />\n` +
' }\n' +
'/>\n'
' }],\n' +
` demo: <${componentExampleName} />,\n` +
` props: { ${componentName} },\n` +
' }\n'
);
};

Expand Down
26 changes: 13 additions & 13 deletions generator-eui/documentation/templates/documentation_page.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,36 +1,36 @@
import React from 'react';

import { renderToHtml } from '../../services';

import {
GuideSectionTypes,
} from '../../components';

import {
EuiText,
<%= componentName %>,
} from '../../../../src/components';
} from '../../../../src';

import <%= componentExampleName %> from './<%= fileName %>';
const <%= componentExamplePrefix %>Source = require('!!raw-loader!./<%= fileName %>');
const <%= componentExamplePrefix %>Html = renderToHtml(<%= componentExampleName %>);

export const <%= componentExampleName %>Example = {
title: '<%= componentExampleName %>',
intro: (
<><EuiText></EuiText></>
),
sections: [{
title: '<%= componentExampleName %>',
text: (
<>
<p>
Description needed: how to use the <strong>Eui<%= componentExampleName %></strong> component.
</p>
</>
),
source: [{
type: GuideSectionTypes.JS,
code: <%= componentExamplePrefix %>Source,
}, {
type: GuideSectionTypes.HTML,
code: <%= componentExamplePrefix %>Html,
}],
text: (
<p>
Description needed: how to use the <strong>Eui<%= componentExampleName %></strong> component.
</p>
),
props: { <%= componentName %> },
demo: <<%= componentExampleName %> />,
props: { <%= componentName %> },
}],
};
2 changes: 1 addition & 1 deletion generator-eui/documentation/templates/documentation_page_demo.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import React from 'react';

import {
<%= componentName %>,
} from '../../../../src/components/<%= folderName %>';
} from '../../../../src';

export default () => (
<<%= componentName %>>
Expand Down