Comments (11)
You could use the <details>
tag to hide the screenshots.
Example
- Example without a screenshot - foo
- Example without a screenshot - qux
Code
* Example without a screenshot - foo
* <details>
<summary>Example with a screenshot - bar</summary>
<img src="https://imgs.xkcd.com/comics/random_number.png">
</details>
* Example without a screenshot - qux
from awesome-readme.
This would confer the benefit of freezing the README in a point of time. At the moment, it is easy for the README to change such that it might not be awesome anymore.
from awesome-readme.
Sure, maybe later today. Not with all screenshots at once, though, as that's a lot of work. 😄
from awesome-readme.
@deltaidea Hmm. How about we link to the commit, and show the image as a screenshot? I think that would solve both of the issues, and allow us to content address it.
Thank you for helping with this!
from awesome-readme.
👍 I was going to suggest that.
from awesome-readme.
👍
from awesome-readme.
@sindresorhus @cheeaun how would you show the screenshots?
Was thinking about a table, and then maybe a cropped screenshot - but looks a little clunky.
from awesome-readme.
Nah, tables are ugly. Just resize it to a retina thumbnail.
from awesome-readme.
@deltaidea that sounds like a great idea. Any chance you'd like to submit a PR?
from awesome-readme.
Wait, I just realized that if we want to preserve a particular version of a readme, we could just link to it with current commit in the URL, like this:
https://github.com/sindresorhus/pageres/blob/7576249b66accd3fb832dc7b65925aa95978ed2a/readme.md
This would be considerably easier to do, and the markdown in our list would remain simple and contributor-friendly.
There're two issues with this approach that are solved by screenshots:
- Badges and other external images may become unreachable and break the visual style.
- Repos can be deleted, in which case the links will still be dead.
from awesome-readme.
Just to revive this, I've noticed somewhere else that they have users submit an image preview with certain dimensions in addition to a link to their repository. Perhaps we can do something like that?
from awesome-readme.
Related Issues (20)
- Add `readme.so` to the Tools section HOT 2
- Is this still maintained? HOT 2
- Maintainers and collaborators? HOT 6
- The Travis Build Fails HOT 1
- Request to add README HOT 2
- Request to add readme of NASA Ogma HOT 1
- Awesome HOT 1
- Analyze my readme HOT 2
- rayhanadev/rayhanadev link dead HOT 2
- AndrOBD readme suggestion HOT 1
- Feedback Demo 1 HOT 1
- Global-Chem README HOT 1
- sidid HOT 1
- Request to list Yampa's README HOT 2
- Request to add a Readme HOT 1
- Categorize examples by ecosystems HOT 9
- We HOT 1
- Include quality ARCHITECTURE and CONTRIBUTING documentation HOT 4
- Awesome Readme - Website HOT 1
- Please consider adding my profile HOT 2
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from awesome-readme.