Skip to content
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

Fix the import of external md files #3472

Merged
merged 16 commits into from
May 1, 2018
Merged

Fix the import of external md files #3472

Show file tree
Hide file tree
Changes from 11 commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
f7cc050
Turn html into markdown when imported externally
Keraito Apr 21, 2018
36b6967
Add an example of importing an external md file
Keraito Apr 21, 2018
cf4825e
Add tests for external md loader
Keraito Apr 21, 2018
d2ed303
Remove turndown
Keraito Apr 24, 2018
8cd3e94
Replace md- and html-loader with raw-loader for react
Keraito Apr 24, 2018
3d01d7c
Replace md- and html-loader with raw-loader for angular
Keraito Apr 26, 2018
5cfd9a1
Replace md- and html-loader with raw-loader for mithril
Keraito Apr 26, 2018
bc833f9
Replace md- and html-loader with raw-loader for react-native
Keraito Apr 26, 2018
d7c8fa7
Replace md- and html-loader with raw-loader for vue
Keraito Apr 26, 2018
9740215
Replace md- and html-loader with raw-loader for polymer
Keraito Apr 26, 2018
dc1d195
Update the examples of handling markdown in notes addon
Keraito Apr 30, 2018
9cffb48
Update commas in examples
Keraito Apr 30, 2018
06fe989
Update basic documentation with new md handling
Keraito Apr 30, 2018
c00f0aa
Combine inline and external md example
Keraito Apr 30, 2018
06e777c
Merge branch 'master' into import-external-md
Hypnosphi Apr 30, 2018
0464ac6
Update storyshots
Keraito May 1, 2018
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
2,023 changes: 2,023 additions & 0 deletions addons/info/src/__snapshots__/index.test.js.snap
View file
Open in desktop

Large diffs are not rendered by default.

6 changes: 6 additions & 0 deletions addons/info/src/index.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ import React from 'react';
import { mount } from 'enzyme';

import AddonInfo, { withInfo, setDefaults } from './';
import externalMdDocs from '../README.md';

/* eslint-disable */
const TestComponent = ({ func, obj, array, number, string, bool, empty }) => (
Expand Down Expand Up @@ -52,6 +53,11 @@ describe('addon Info', () => {

expect(mount(<Info />)).toMatchSnapshot();
});
it('should render <Info /> and external markdown', () => {
const Info = withInfo(externalMdDocs)(story);

expect(mount(<Info />)).toMatchSnapshot();
});
it('should render with text options', () => {
const Info = withInfo({ text: 'some text here' })(story);
mount(<Info />);
Expand Down
6 changes: 3 additions & 3 deletions addons/notes/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ storiesOf('Component', module)

#### Using Markdown

To use markdown in your notes simply import a markdown file and use that in your note.
To use markdown in your notes simply import a markdown file and use that in the `markdown` property of your note.

```js
import { storiesOf } from '@storybook/react';
Expand All @@ -62,11 +62,11 @@ import someMarkdownText from './someMarkdownText.md';
storiesOf('Component', module).add(
'With Markdown',
() => <Component />
{ notes: someMarkdownText }
{ notes: { markdown: someMarkdownText } }
);
```

If you want to use Github flavored markdown inline, use `notes: { markdownText: 'your md' }`:
Similarly, if you want to use Github flavored markdown inline, use `notes: { markdownText: 'your md' }`:
Copy link
Member

@Hypnosphi Hypnosphi Apr 30, 2018 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like markdownText part is a typo in current docs, the example below uses markdown

Also, after your change there's no difference in handling inline vs imported markdown, so you can just remove this paragraph

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Combined the text for both examples and removed the 2nd paragraph. Please let me know if you think the description needs to be adjusted!


```js
import { storiesOf } from '@storybook/react';
Expand Down
2 changes: 0 additions & 2 deletions app/angular/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,7 @@
"core-js": "^2.5.5",
"dotenv-webpack": "^1.5.5",
"global": "^4.3.2",
"html-loader": "^0.5.5",
"html-webpack-plugin": "^3.2.0",
"markdown-loader": "^2.0.2",
"raw-loader": "^0.5.1",
"sass-loader": "^7.0.1",
"ts-loader": "^4.2.0",
Expand Down
9 changes: 1 addition & 8 deletions app/angular/src/server/config/webpack.config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,14 +95,7 @@ export default function(configDir) {
},
{
test: /\.md$/,
use: [
{
loader: require.resolve('html-loader'),
},
{
loader: require.resolve('markdown-loader'),
},
],
loader: require.resolve('raw-loader'),
},
],
},
Expand Down
9 changes: 1 addition & 8 deletions app/angular/src/server/config/webpack.config.prod.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,14 +92,7 @@ export default function(configDir) {
},
{
test: /\.md$/,
use: [
{
loader: require.resolve('html-loader'),
},
{
loader: require.resolve('markdown-loader'),
},
],
loader: require.resolve('raw-loader'),
},
],
},
Expand Down
3 changes: 1 addition & 2 deletions app/mithril/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,9 +38,8 @@
"core-js": "^2.5.5",
"dotenv-webpack": "^1.5.5",
"global": "^4.3.2",
"html-loader": "^0.5.5",
"html-webpack-plugin": "^3.2.0",
"markdown-loader": "^2.0.2",
"raw-loader": "^0.5.1",
"webpack": "^4.6.0",
"webpack-hot-middleware": "^2.22.1"
},
Expand Down
9 changes: 1 addition & 8 deletions app/mithril/src/server/config/webpack.config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,14 +73,7 @@ export default function(configDir) {
},
{
test: /\.md$/,
use: [
{
loader: require.resolve('html-loader'),
},
{
loader: require.resolve('markdown-loader'),
},
],
loader: require.resolve('raw-loader'),
},
],
},
Expand Down
9 changes: 1 addition & 8 deletions app/mithril/src/server/config/webpack.config.prod.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,14 +68,7 @@ export default function(configDir) {
},
{
test: /\.md$/,
use: [
{
loader: require.resolve('html-loader'),
},
{
loader: require.resolve('markdown-loader'),
},
],
loader: require.resolve('raw-loader'),
},
],
},
Expand Down
1 change: 1 addition & 0 deletions app/polymer/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@
"dotenv-webpack": "^1.5.5",
"global": "^4.3.2",
"html-webpack-plugin": "^3.2.0",
"raw-loader": "^0.5.1",
"webpack": "^4.6.0",
"webpack-hot-middleware": "^2.22.1"
},
Expand Down
4 changes: 4 additions & 0 deletions app/polymer/src/server/config/webpack.config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,10 @@ export default function(configDir) {
},
],
},
{
test: /\.md$/,
loader: require.resolve('raw-loader'),
},
],
},
resolve: {
Expand Down
4 changes: 4 additions & 0 deletions app/polymer/src/server/config/webpack.config.prod.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,10 @@ export default function(configDir) {
},
],
},
{
test: /\.md$/,
loader: require.resolve('raw-loader'),
},
],
},
resolve: {
Expand Down
3 changes: 1 addition & 2 deletions app/react-native/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,11 +52,10 @@
"express": "^4.16.3",
"find-cache-dir": "^1.0.0",
"global": "^4.3.2",
"html-loader": "^0.5.5",
"html-webpack-plugin": "^3.2.0",
"json5": "^1.0.1",
"markdown-loader": "^2.0.2",
"prop-types": "^15.6.1",
"raw-loader": "^0.5.1",
"react-native-compat": "^1.0.0",
"react-native-iphone-x-helper": "^1.0.2",
"shelljs": "^0.8.1",
Expand Down
9 changes: 1 addition & 8 deletions app/react-native/src/server/config/webpack.config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,14 +46,7 @@ const getConfig = options => ({
},
{
test: /\.md$/,
use: [
{
loader: require.resolve('html-loader'),
},
{
loader: require.resolve('markdown-loader'),
},
],
loader: require.resolve('raw-loader'),
},
],
},
Expand Down
9 changes: 1 addition & 8 deletions app/react-native/src/server/config/webpack.config.prod.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,14 +50,7 @@ const getConfig = options => {
},
{
test: /\.md$/,
use: [
{
loader: require.resolve('html-loader'),
},
{
loader: require.resolve('markdown-loader'),
},
],
loader: require.resolve('raw-loader'),
},
],
},
Expand Down
3 changes: 1 addition & 2 deletions app/react/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,11 +42,10 @@
"glamor": "^2.20.40",
"glamorous": "^4.12.3",
"global": "^4.3.2",
"html-loader": "^0.5.5",
"html-webpack-plugin": "^3.2.0",
"lodash.flattendeep": "^4.4.0",
"markdown-loader": "^2.0.2",
"prop-types": "^15.6.1",
"raw-loader": "^0.5.1",
"webpack": "^4.6.0",
"webpack-hot-middleware": "^2.22.1"
},
Expand Down
9 changes: 1 addition & 8 deletions app/react/src/server/config/webpack.config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,14 +73,7 @@ export default function(configDir) {
},
{
test: /\.md$/,
use: [
{
loader: require.resolve('html-loader'),
},
{
loader: require.resolve('markdown-loader'),
},
],
loader: require.resolve('raw-loader'),
},
],
},
Expand Down
9 changes: 1 addition & 8 deletions app/react/src/server/config/webpack.config.prod.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,14 +68,7 @@ export default function(configDir) {
},
{
test: /\.md$/,
use: [
{
loader: require.resolve('html-loader'),
},
{
loader: require.resolve('markdown-loader'),
},
],
loader: require.resolve('raw-loader'),
},
],
},
Expand Down
3 changes: 1 addition & 2 deletions app/vue/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,9 +38,8 @@
"core-js": "^2.5.5",
"dotenv-webpack": "^1.5.5",
"global": "^4.3.2",
"html-loader": "^0.5.5",
"html-webpack-plugin": "^3.2.0",
"markdown-loader": "^2.0.2",
"raw-loader": "^0.5.1",
"webpack": "^4.6.0",
"webpack-hot-middleware": "^2.22.1"
},
Expand Down
9 changes: 1 addition & 8 deletions app/vue/src/server/config/webpack.config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,14 +78,7 @@ export default function(configDir) {
},
{
test: /\.md$/,
use: [
{
loader: require.resolve('html-loader'),
},
{
loader: require.resolve('markdown-loader'),
},
],
loader: require.resolve('raw-loader'),
},
],
},
Expand Down
9 changes: 1 addition & 8 deletions app/vue/src/server/config/webpack.config.prod.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,14 +73,7 @@ export default function(configDir) {
},
{
test: /\.md$/,
use: [
{
loader: require.resolve('html-loader'),
},
{
loader: require.resolve('markdown-loader'),
},
],
loader: require.resolve('raw-loader'),
},
],
},
Expand Down
Loading