add GitHub flavored markdown notes #2946
Conversation
update my branch
update my fork
| @@ -3,18 +3,19 @@ | |||
| [](https://circleci.com/gh/storybooks/storybook) | |||
| [](https://www.codefactor.io/repository/github/storybooks/storybook) | |||
| [](https://snyk.io/test/github/storybooks/storybook/8f36abfd6697e58cd76df3526b52e4b9dc894847) | |||
| [](https://bettercodehub.com/results/storybooks/storybook) [](https://codecov.io/gh/storybooks/storybook) | |||
| [](https://bettercodehub.com/results/storybooks/storybook) [](https://codecov.io/gh/storybooks/storybook) | |||
There was a problem hiding this comment.
looks like my Prettier reformatted this README.md a bit, this can be ignored
There was a problem hiding this comment.
Can you please revert stylistic changes?
addons/notes/README.md
Outdated
| </div> | ||
| ~~~ | ||
| `)(() => <Component />) | ||
| ); |
There was a problem hiding this comment.
this is the relevant new documentation of the new exposed API. pretty simple.
|
Please add a usage example to storybook-official |
|
You probably need to run |
|
For some reason, it just displays raw markdown sources instead of formatted text |
OK, it's because of the indentation in the example. Indent is just another way to define code block |
Codecov Report
@@ Coverage Diff @@
## master #2946 +/- ##
========================================
Coverage ? 92.5%
========================================
Files ? 6
Lines ? 40
Branches ? 2
========================================
Hits ? 37
Misses ? 2
Partials ? 1Continue to review full report at Codecov.
|
|
ahh thats why. sorry I hadn't had time last week to get around to this, glad you figured it out. was definitely working in my local setup. im still in the first month of my new job, got to figure out what my ability is to work on open source :( thank you so much for being an awesome maintainer, I hope to be a better contributor over time |
closes #2916 (comment)