Add interactive examples to README
See original GitHub issueWhat:
The README should include the list of examples. Each example item should contain:
- A thumbnail image.
- A title.
- A short description on the example’s purpose.
- A link to the interactive playground (Codesandbox) with the respective example.
Why:
Carefully designed, a list of examples may substitute documentation at its entirety. At least it’s a great illustrative showcase for practical learners and beyond.
How:
I suggest to split examples into sections based on the complexity level.
Basics
- Basic composition. Example of two elements combining into a composition. Can be icon and text, or anything.
- Responsive props. Shows how to use Responsive props. Can utilize the previous “Basic composition” example, but improve it with some responsive props to show the change.
- Nested composition
Intermediate
- Conditional rendering. Showcases the usage of the
<Only/>
component. - Custom configuration. Example of using
Layout.configure()
to set custom breakpoints and custom measurement unit. - Demonstrate how to use the
query()
utility function to compose inline media queries instyled-components
Advanced
- Responsive sife effect. How to execute any side effect upon breakpoint change (
useResponsiveQuery
) - Responsive component. How to add Responsive props support to any React component.
- SSR of conditional components. How to use
<Visible/>
to conditionally render components and support client-side hydration.
Issue Analytics
- State:
- Created 4 years ago
- Comments:6 (6 by maintainers)
Top Results From Across the Web
How to create an interactive README for your GitHub profile
1) Create a new GitHub repo with the same name as your username. · 2) Create an account on Link Click Counter using...
Read more >Make a README
Learn how to make a great README for your programming project, and use the editable template to get started.
Read more >Add Interactive and beautiful README to Your GitHub Profile ...
Checkout For example: 2. After the above step, open the created repository then you will see README.
Read more >How to add interactive plots to a readme file (generated in R ...
... these as examples of what the package can do in my README file, but unfortunately it seems that github documents don't allow...
Read more >How to Write a Good README File for Your GitHub Project
Provide instructions and examples so users/contributors can use the project. This will make it easy for them in case they encounter a problem...
Read more >Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start FreeTop Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
Top GitHub Comments
I will edit this comment if I finish more examples.
Basics
Intermediate
@dandelionadia, thank you for the fixes! Please, if I may, there are a few more comments.
Conditional rendering
Logo.js
(svg element).Custom configuration
data
array into a separate JSON file (i.e.data.json
).maxWidth={16}
andmaxWidthTablet={30}
onAlbum.js
component? So it doesn’t stretch full-width on small screens.