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.

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

Link to source code on docs. #1201

Open
wirekang opened this issue Apr 12, 2023 · 4 comments
Open

Link to source code on docs. #1201

wirekang opened this issue Apr 12, 2023 · 4 comments
Labels
📄 documentation Improvements or additions to documentation

Comments

@wirekang
Copy link

New Features

What is the new or updated feature that you are suggesting?

It would be great if reader can show the original source code of the hook.

Why should this feature be included?

It helps to understand how things work.

@ArttuOll ArttuOll added the 📄 documentation Improvements or additions to documentation label Apr 12, 2023
@ArttuOll
Copy link
Contributor

We're currently planning to move to a whole new docs system. We'll make sure to consider this when the new docs start taking shape!

@fredericrous
Copy link

fredericrous commented Aug 17, 2024

storybook is a solid choice in 2024. not that I'm a huge fan but it does the job and still gets regularly updated.
note that sometimes for the show code to work, I need to define an empty object as an argument to the export function

before

export function Example() {

after

export function Example({}) {

I know that's weird 😆

@xobotyi
Copy link
Contributor

xobotyi commented Aug 17, 2024

Yet still they force everyone to rewrite all docs every other major release.

@fredericrous
Copy link

the alternatives are limited tho?

I loved react-cosmos.. but my experience with it was that it was a pain to make it work on projects and it gets updated rather slowly.

I tried ladle, I don't like its interface nor the way it shows code, and there's no place for written doc.

An alternative I haven't tried is Docusaurus, it's from facebook after all.

In the mid-time I'm happy using storybook v8. I tried not to use it but in the end it does the job and is customizable, plus I only upgrade it when React gets updated and it comes with an upgrade command powered by codemod

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📄 documentation Improvements or additions to documentation
Development

No branches or pull requests

4 participants