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 rule copy link buttons #732

Open
SmilyOrg opened this issue Jun 16, 2022 · 2 comments
Open

Add rule copy link buttons #732

SmilyOrg opened this issue Jun 16, 2022 · 2 comments

Comments

@SmilyOrg
Copy link
Member

Rule headings could contain a variety of small icons at the end of them for quick copy-pasting into documents, chats, and comments.

I've thought about two specifically for now - the second one of which would be most handy for PRs and GitHub issues.

1. 🔗 - Regular link

This just copies the URL to clipboard and nothing else. One less action compared to now :)

2. - Markdown link

Copies a Markdown-formatted link to clipboard so you can very easily reference it in e.g. a GitHub issue. This would make it easy to produce meaningful links instead of raw URLs or manual editing.

Some format ideas:

1. [MUST use standard formats for date and time properties [169]](https://opensource.zalando.com/restful-api-guidelines/#169)
2. [MUST use standard formats for date and time properties](https://opensource.zalando.com/restful-api-guidelines/#169)
3. [REST [169] MUST use standard formats for date and time properties](https://opensource.zalando.com/restful-api-guidelines/#169)
4. [RESTful #169](https://opensource.zalando.com/restful-api-guidelines/#169)
5. [REST #169](https://opensource.zalando.com/restful-api-guidelines/#169)

Markdown icon source: https://commons.wikimedia.org/wiki/File:Markdown-mark.svg

@ePaul
Copy link
Member

ePaul commented Aug 20, 2024

Additional idea: At the beginning of each chapter, add an edit link/button pointing to the corresponding .adoc-file on Github.

@ePaul
Copy link
Member

ePaul commented Nov 12, 2024

The second part now got a bit less urgent, as Github now can insert formatted HTML as markdown.

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

No branches or pull requests

4 participants