Skip to content

Conversation

@pdeschain
Copy link
Contributor

@pdeschain pdeschain commented Mar 15, 2021

Github markdown doesn't really support text colors. I opted to use colored smileys: 🟡.
Alternatively we could go with (suggested by @LukeStampfli ):

- Important red message

@pdeschain pdeschain added 2-Easy This PR is trivial and can be reviewed quickly 1-Needs Review PR needs attention from the assignee and reviewers labels Mar 15, 2021
@SamuelBellomo
Copy link
Contributor

Could a table help highlight this? Or even a table + red color?

@pdeschain pdeschain changed the base branch from develop to release/v0.1.0-experimental March 15, 2021 21:46
@pdeschain
Copy link
Contributor Author

Github markdown does not support text color. What Luke suggested is a hack that makes use of code highlighting features that github has enabled as a part of it's markdown flavor.

Below are the alternatives I was able to come up with, let me know which one you like best:

(1)

- IMPORTANT: This project is currently experimental.

(2)

🛑IMPORTANT🛑 This project is currently experimental.

(3)
🛑🛑🛑IMPORTANT: This project is currently experimental.🛑🛑🛑

I was unable to combine (1) and (2), but 🛑 and other smileys similar to that one can be used anywhere we can use regular text.

Below is the link to the discussion of the topic on SO: https://stackoverflow.com/questions/11509830/how-to-add-color-to-githubs-readme-md-file

@pdeschain pdeschain force-pushed the feature/highlight-experimental-status-in-readme branch from 3c9a0dc to 92ff3c1 Compare March 19, 2021 20:02
@pdeschain pdeschain changed the title Highlight experimental status in readme Highlight EARLY ACCESS status in readme Mar 23, 2021
@SamuelBellomo SamuelBellomo added the 0-URGENT Blocker for a release and needs to be merged ASAP label Mar 29, 2021
@SamuelBellomo SamuelBellomo assigned lkrell and unassigned LukeStampfli Mar 29, 2021
Copy link
Contributor

@lkrell lkrell left a comment

Choose a reason for hiding this comment

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

Looks good!

@pdeschain pdeschain merged commit b432748 into release/v0.1.0-experimental Mar 29, 2021
@pdeschain pdeschain deleted the feature/highlight-experimental-status-in-readme branch March 29, 2021 20:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

0-URGENT Blocker for a release and needs to be merged ASAP 1-Needs Review PR needs attention from the assignee and reviewers 2-Easy This PR is trivial and can be reviewed quickly

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants