79 Commits

Author SHA1 Message Date
Meet Patel
5338fe7689
Update doc-blocks.md
Fixed typos.
2021-10-16 23:12:38 +05:30
jonniebigodes
56f2d3a72a removes snippets from vue docs 2021-08-12 23:07:01 +01:00
jonniebigodes
d7ba0fca3b adjustments per feedback 2021-08-11 14:30:18 +01:00
jonniebigodes
68c3949ac9 adjusts the docs for syntax highlighting 2021-08-10 21:40:19 +01:00
jonniebigodes
0f01c6adef complements the docs with MDX 2021-08-05 18:51:23 +01:00
jonniebigodes
d29ac012f0
Merge pull request #15444 from RickCardoso/fix/docs-page-with-mdx-snippet
fix: docs-page with mdx and id explanation
2021-08-03 15:38:57 +01:00
Ricardo Cardoso
4f20e90708
refactor: review tweaks 2021-07-21 14:55:33 -03:00
Matt Darveniza
8ad7c83b59 Merge branch 'next' of https://github.com/storybookjs/storybook into mdx-argstable-stories 2021-07-13 10:49:06 +10:00
Kai-Wen, Hsiung
eb72096246
Add missing space
I've found a missing space between "or" and "CSF" of the paragraph "It will look for any stories available either in MDX or CSF and based on the documentation you've added it will display it..."
2021-07-04 20:12:47 +08:00
Ricardo Cardoso
5a3028b9e2 fix: docs-page with mdx and id explanation 2021-06-30 15:01:18 -03:00
jonniebigodes
07ce1a0a3a addresses varun feedback 2021-06-15 20:05:58 +01:00
jonniebigodes
6960cbb2f7 docs changes for docspage 2021-06-11 21:34:09 +01:00
jonniebigodes
f06074924c fixes for issue 14218 2021-05-12 19:33:26 +01:00
jonniebigodes
0b03e56265 Adds the svelte snippets to the docs 2021-05-06 17:36:21 +01:00
Charles Gruenais
83c266aa93 applied @jonniebigodes adjustment 2021-05-04 21:24:20 +02:00
Charles Gruenais
cc2ec60b57 Added section about linking to other stories from MDX 2021-05-02 14:31:11 +02:00
Michael Shilman
c6bdd680dc
Merge pull request #14181 from storybookjs/adjust_links_to_addons_gallery
Chore: (Docs) Adjusts links to the addons gallery
2021-03-10 05:58:53 +08:00
jonniebigodes
ed89061443 adjusts the docs to address #14148 2021-03-09 20:13:57 +00:00
jonniebigodes
beab98a4d7 adjusts links to the addons gallery 2021-03-09 18:11:39 +00:00
jonniebigodes
06e8358c82 remove writing docs reference 2021-03-04 20:13:02 +00:00
jonniebigodes
ab2d8ffc30 address issue with MDX stories 2021-03-04 20:02:05 +00:00
jonniebigodes
fe745ba2d0 Renames the vue snippets for clarity 2021-02-24 17:56:50 +00:00
jonniebigodes
fc0a67c523 Adjusts snippets for Vue 3 and other minor tweaks. 2021-02-23 00:26:03 +00:00
Yngve Bakken-Nilsen
b7c44a13a1 make source-language configurable 2021-02-10 23:08:36 +01:00
jonniebigodes
a93000c541 updates per Blaine feedback 2021-01-27 22:28:55 +00:00
jonniebigodes
f25b27ca6b adds missing angular scripts 2021-01-27 20:43:31 +00:00
j3rem1e
4022f08de4 Adding svelte examples in the documentation 2021-01-21 20:22:57 +01:00
jonniebigodes
4738c4e3f4 address Tom's feedback 2021-01-13 16:28:43 +00:00
jonniebigodes
c14f6a23e7 chore: Add missing snippets for vue 2020-12-23 17:00:49 +00:00
jonniebigodes
639801d3e5 chore: addon documentation restructuring 2020-12-02 15:25:40 +00:00
Michael Shilman
6316d49cb3 Add source highlighting languages 2020-11-25 12:25:52 +08:00
Frederick Ros
79bd9b1ddb
Update doc-blocks.md
Fixed wrong description of the ``type.detail``, ``defaultValue.summary`` and ``defaultValue.detail`` entries (look like copy & paste ;))
2020-11-15 10:12:41 +01:00
jonniebigodes
ccdaae9b68 chore:updates for the writing docs section 2020-10-28 22:44:37 +00:00
Florent Berthelot
702fa31de3
📝 Add reference to Canvas isColumn props
to improve the doc
2020-10-22 10:49:53 +02:00
jonniebigodes
8ade193267
Merge pull request #12628 from whoisryosuke/patch-4
Fix copy for Docs
2020-10-12 21:54:15 +01:00
jonniebigodes
0c9ec6b030 Broken links fixed 2020-10-08 23:35:41 +01:00
Ryosuke
51f9cfc027
updated wording 2020-10-02 14:04:27 -07:00
Michael Shilman
cdd97a8bfb
Merge pull request #12629 from whoisryosuke/patch-5
Relative link to docs broken
2020-10-01 03:49:27 +08:00
jonniebigodes
abe4af52ae fixes issue 12611 2020-09-30 19:58:27 +01:00
Ryosuke
16c7a63057
Relative link to docs broken
The link to Storybook docs was relative, which on [the production site](https://storybook.js.org/docs/react/writing-docs/docs-page) links to the **next** branch, instead of the **master**.

Old link using relative:
`https://github.com/storybookjs/storybook/blob/next/addons/docs/README`

New link:
`https://github.com/storybookjs/storybook/blob/master/addons/docs/README.md`

Not sure if there's a way to use the relative link and have it point to master instead of next? But for now, hard-coded link will definitely work.
2020-09-30 11:04:40 -07:00
Ryosuke
ef1d42df3f
Fix copy for Docs
The website state that DocsPage is available out of the box with Storybook. After upgrading to Storybook v6 in a recent project, I didn't have access to Docs, and had to install the addon separately. You can also see in the [next page](https://storybook.js.org/docs/react/writing-docs/docs-page) that it states you need to install Storybook Docs to get access to DocsPage (which is more accurate, albeit conflicting and confusing in it's present state).

I changed the copy from `Out of the box` to `When you install Storybook Docs` to clarify that the user does indeed need to install the addon to access the functionality.
2020-09-30 11:01:10 -07:00
Josh Soref
6561efbbd3 spelling: shorthand
Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>
2020-09-29 09:42:31 -04:00
Michael Shilman
90f5686c2f Addon-docs: Document dynamic source snippets 2020-09-21 17:11:30 +08:00
jonniebigodes
ba45ba963f
Merge branch 'next' into docs/hotfix/links 2020-09-16 20:49:06 +01:00
Dominic Nguyen
48b9452bf5
Broken link fix 2020-08-29 10:09:03 -04:00
Andreas Kohn
c92b6968cd
Fix the link to the "advanced readme" 2020-08-28 19:52:10 +02:00
jonniebigodes
230ffc090d fixes 12205 2020-08-26 20:21:50 +01:00
novella
ada0162424 Update link to argTypes page 2020-08-20 14:25:05 -04:00
Matt Darveniza
8042564e61 Add example codesnippet for using ArgsTable with stories 2020-08-20 17:19:48 +10:00
jonniebigodes
d44f7901cb fixes link to point at correct api section 2020-08-19 16:42:00 +01:00