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

docs: add copy to clip for code snippets #1981

Merged
merged 2 commits into from
Jul 6, 2023
Merged

Conversation

wgwz
Copy link
Contributor

@wgwz wgwz commented Jul 6, 2023

Description

This should add the ability for the code snippets in the documentation to have a copy to clipboard feature.
I tried testing locally but encountered some errors after doing a fresh clone, and cd-ing to docs and running yarn && yarn dev.
It was a bunch of messages like this:

sed: 1: "commands/regen_version.md": command c expects \ followed by text   

But it does seem to be working in deploy preview!
https://deploy-preview-1981--regen-ledger-docs.netlify.app/


Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

  • included the correct type prefix in the PR title
  • added ! to the type prefix if API or client breaking change
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • followed the guidelines for building modules
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • included comments for documenting Go code
  • updated the relevant documentation or specification
  • reviewed "Files changed" and left comments if necessary
  • confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

I have...

  • confirmed the correct type prefix in the PR title
  • confirmed ! in the type prefix if API or client breaking change
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic
  • reviewed API design and naming
  • reviewed documentation is accurate
  • reviewed tests and test coverage
  • manually tested (if applicable)

@wgwz wgwz requested review from ryanchristo and blushi July 6, 2023 10:28
Copy link
Member

@ryanchristo ryanchristo left a comment

Choose a reason for hiding this comment

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

LGTM. The sed errors are likely due to you being on a mac. Nothing to worry about.

@ryanchristo ryanchristo added the backport/v5.1.x backport to release/v5.1.x branch label Jul 6, 2023
@ryanchristo ryanchristo merged commit 763d14b into regen-network:main Jul 6, 2023
mergify bot pushed a commit that referenced this pull request Jul 6, 2023
Co-authored-by: Ryan Christoffersen <12519942+ryanchristo@users.noreply.github.com>
(cherry picked from commit 763d14b)

# Conflicts:
#	docs/package.json
ryanchristo added a commit that referenced this pull request Jul 6, 2023
Co-authored-by: Kyle Lawlor-Bagcal <wgwz@users.noreply.github.com>
Co-authored-by: ryanchristo <12519942+ryanchristo@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport/v5.1.x backport to release/v5.1.x branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants