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

👌 IMPROVE: Screenshots & Formatting #84

Open
wants to merge 19 commits into
base: master
Choose a base branch
from

Conversation

ahmadawais
Copy link
Contributor

@ahmadawais ahmadawais commented Sep 4, 2019

This PR includes an improved formatting of the README.md file with better/bigger screenshots.

❯❯ Live Demo →

Looking forward, peace! ✌️

@mAAdhaTTah
Copy link
Member

I appreciate the effort here but this is going to be resolved by #80. Thank you for contributing!

@mAAdhaTTah mAAdhaTTah closed this Sep 4, 2019
@mAAdhaTTah
Copy link
Member

If you want, you can resubmit just the README changes and we can look at that.

@mAAdhaTTah mAAdhaTTah reopened this Sep 4, 2019
@mAAdhaTTah mAAdhaTTah closed this Sep 4, 2019
@RunDevelopment
Copy link
Member

I really like this design!
The thing I would have to criticize is that the larger screenshots take up a lot of screen space which makes that page quite long. If we do it like this, the available themes section should be the last looking at #80.

Also: With the code snippet (really nice idea), we have to write the name of the theme 3 times. Maybe we could make a themes.json (similar to components.json) and generate the available themes section?

@ahmadawais
Copy link
Contributor Author

ahmadawais commented Sep 4, 2019 via email

@mAAdhaTTah mAAdhaTTah reopened this Sep 4, 2019
@mAAdhaTTah
Copy link
Member

I'm going to hold this for a minute and get #80 in. Once that's landed, could you merge/rebase this PR so the changes you made to the build process are included? Then we can adjust the sizes if we like.

@RunDevelopment
Copy link
Member

@ahmadawais Since the available themes section is the last one now, I think the larger screenshots are ok.
My only concern was that people would miss some of the information in README because they didn't scroll all the way down, but that's not an issue anymore.

@ahmadawais
Copy link
Contributor Author

Awesome. Can we merge this one? I have modified the PR #80 and will send another PR that wraps what #80 does and more (fixes in CSS, and gulp file for options on screenshots).

@mAAdhaTTah
Copy link
Member

@ahmadawais #80 is in. You can merge that up to this branch and push your modifications here so we can get the new README design + new screenshot process in at once.

Thanks!

@mAAdhaTTah
Copy link
Member

Also: With the code snippet (really nice idea), we have to write the name of the theme 3 times. Maybe we could make a themes.json (similar to components.json) and generate the available themes section?

Let's consider this in a separate PR, although given how infrequently this README changes, I'm not really sure it's necessary.

@RunDevelopment
Copy link
Member

given how infrequently this README changes, I'm not really sure it's necessary.

Just an idea. But that's definitely its own PR.

Copy link
Member

@RunDevelopment RunDevelopment left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ahmadawais
From my perspective, this PR just needs rebasing and a few minor changes.
You also have to incorporate your changes to the screenshot task, so that we can recreate the screenshots anytime.

If you need any help, I'll be happy to help.


To use one of the themes, just include the theme's CSS file in your page. Example:
To use one of the themes, include theme's `css` file (present in the [themes directory](themes)) in your page. For example:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
To use one of the themes, include theme's `css` file (present in the [themes directory](themes)) in your page. For example:
To use one of the themes, include the theme's `css` file (present in the [themes directory](themes)) in your page. For example:

</body>
<head>
...
<!-- <link href="prism-[theme-name-here].css" rel="stylesheet" /> -->
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we really need this comment? Isn't the line below enough?

@@ -1,80 +1,214 @@
# Prism themes
# Prism.js Themes
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We just call ourselves "Prism", so I think we should go with the old heading.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants