Skip to content

Correct escaping so copying code matches screenshots #18352

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
Merged
merged 3 commits into from
Jun 2, 2022
Merged

Correct escaping so copying code matches screenshots #18352

merged 3 commits into from
Jun 2, 2022

Conversation

perpil
Copy link
Contributor

@perpil perpil commented May 31, 2022

Why:

Escape code block to allow nested code blocks correctly per this. Currently, copying the code and pasting doesn't render the code block as syntax highlighted code like the screenshot.

Click CLICK ME on both examples to see difference

It looks like this:

CLICK ME

We can hide anything, even code!

```ruby
  puts "Hello World"
```

Not this:

CLICK ME

We can hide anything, even code!

   puts "Hello World"

What's being changed:

Fixes escaping

Check off the following:

  • [ x] I have reviewed my changes in staging (look for "Automatically generated comment" and click Modified to view your latest changes).
  • [ x] For content changes, I have completed the self-review checklist.

Writer impact (This section is for GitHub staff members only):

  • This pull request impacts the contribution experience
    • I have added the 'writer impact' label
    • I have added a description and/or a video demo of the changes below (e.g. a "before and after video")

@perpil
Update organizing-information-with-collapsed-sections.md
401edab 
Escape code block to allow nested code blocks correctly per [this](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks#fenced-code-blocks).  Currently, copying the code and pasting into a github wiki doesn't render the code block as syntax highlighted code like the screenshot.

It looks like this:

<details><summary>CLICK ME</summary>
<p>

#### We can hide anything, even code!

    ```ruby
      puts "Hello World"
    ```

</p>
</details>

Not this:

<details><summary>CLICK ME</summary>
<p>

#### We can hide anything, even code!

```ruby
   puts "Hello World"
```

</p>
</details>
@welcome
Copy link

welcome bot commented May 31, 2022

Thanks for opening this pull request! A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label May 31, 2022
@github-actions
Copy link
Contributor

github-actions bot commented May 31, 2022 •
edited
Loading

Automatically generated comment ℹ️

This comment is automatically generated and will be overwritten every time changes are committed to this branch.

The table contains an overview of files in the content directory that have been changed in this pull request. It's provided to make it easy to review your changes on the staging site. Please note that changes to the data directory will not show up in this table.

Content directory changes

You may find it useful to copy this table into the pull request summary. There you can edit it to share links to important articles or changes and to give a high-level overview of how the changes in your pull request support the overall goals of the pull request.

Source Preview Production What Changed
get-started/writing-on-github/working-with-advanced-formatting/organizing-information-with-collapsed-sections.md fpt
ghec
ghes@ 3.5 3.4 3.3 3.2 3.1
ghae
 fpt
ghec
ghes@ 3.5 3.4 3.3 3.2 3.1
ghae

@cmwilson21 cmwilson21 added content This issue or pull request belongs to the Docs Content team waiting for review Issue/PR is waiting for a writer's review and removed triage Do not begin working on this issue until triaged by the team labels Jun 1, 2022
@cmwilson21
Copy link
Contributor

@perpil Thanks so much for opening a PR! I'll get this triaged for review ⚡

@cmwilson21 cmwilson21 added the ready to merge This pull request is ready to merge label Jun 2, 2022
cmwilson21
cmwilson21 approved these changes Jun 2, 2022
View reviewed changes
Copy link
Contributor

@cmwilson21 cmwilson21 left a comment

Choose a reason for hiding this comment

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

@perpil Great catch! These changes look great to me. I'll go ahead and merge this PR once all the tests have passed.

Thank you for your contribution and for your passion in improving our docs! ✨

@cmwilson21 cmwilson21 merged commit 07a8a4c into github:main Jun 2, 2022
@github-actions
Copy link
Contributor

github-actions bot commented Jun 2, 2022

Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours. If you're looking for your next contribution, check out our help wanted issues ⚡

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

@cmwilson21 cmwilson21 cmwilson21 approved these changes

Assignees
No one assigned
Labels
content This issue or pull request belongs to the Docs Content team ready to merge This pull request is ready to merge waiting for review Issue/PR is waiting for a writer's review
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@perpil @cmwilson21