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

Add screenshot to the readme #332

Open
Reinmar opened this issue Jun 24, 2022 · 1 comment · May be fixed by #410
Open

Add screenshot to the readme #332

Reinmar opened this issue Jun 24, 2022 · 1 comment · May be fixed by #410
Labels
squad:features task Neither a bug nor a feature request

Comments

@Reinmar
Copy link
Member

Reinmar commented Jun 24, 2022

Cause it should be here :)

@Reinmar Reinmar added the task Neither a bug nor a feature request label Jun 24, 2022
@mateuszzagorski
Copy link
Contributor

I was wondering if we shouldn't go a little bit further with this - possibly creating a visual table comparison between 'old' Github and Github Writer.

What I mean by that is, for example:

 GitHub DefaultGitHub Writer
Tables| OrderDate | Region | Rep |
|---|---|---|
| 9/1/14 | Central | Smith |
| 6/17/15 | Central | Kivell |
Mermaid```mermaid
flowchart TB
A --> B
B --> C
```

Highlighting the new functionalities could be an option as well of course.

Although we would have to find a solution for two problems:

  1.  I believe there should be some kind of additional textual explanation of what is going on regarding the mermaid for example. Adding a column is a possibility, but because of that the images would shrink significantly. 

  2. The other thing is to add proper screenshots, if I'm not missing anything, we would be forced to add additional logic to detect which theme is the person viewing the readme using ( light or dark ), and based on that alter the displayed image. 

    // This part is pretty straightforward in Markdown:

![GitHub-Mark-Light](https://user-images.githubusercontent.com/11699569/197994809-d381e1c2-b1a4-4481-9de0-8301f67fbfc8.png#gh-dark-mode-only)
![GitHub-Mark-Dark](https://user-images.githubusercontent.com/11699569/197999885-cedab563-3fce-4966-bfcd-52dd541a2f05.png#gh-light-mode-only)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
squad:features task Neither a bug nor a feature request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants