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.

Sign up for GitHub

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

Jump to bottom

Clearer Markdown Instructions #3

Open
blakeelias opened this issue Jan 22, 2024 · 1 comment
Open

Clearer Markdown Instructions #3

blakeelias opened this issue Jan 22, 2024 · 1 comment
Assignees
@blakeelias @zoelin1122
Labels
enhancement New feature or request good first issue Good for newcomers

Comments

@blakeelias
Copy link
Collaborator

blakeelias commented Jan 22, 2024 •
edited
Loading

What sections or details would you like to see added/edited in Reward Reports? Why?

The report editor currently gives the following instructions:

Links should be formatted as [Hyperlink text](Link URL). e.g. [Reward Reports](https://rewardreports.github.io/)

Images should be formatted as ![Image alt text](Image src URL).
e.g. ![Reward Reports Logo](https://github.com/RewardReports/reward-reports/raw/main/_assets/icon.png)

This could instead be a simpler message, e.g. "Markdown is supported" (which is how Github indicates this), potentially with a live preview:

image
@blakeelias blakeelias added enhancement New feature or request good first issue Good for newcomers labels Jan 22, 2024
@zoelin1122
Copy link
Collaborator

Sounds good! I'll take a look at this coming week

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@blakeelias blakeelias

@zoelin1122 zoelin1122

Labels
enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@blakeelias @zoelin1122