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

Update to "Styling text" section #17777

Merged
merged 3 commits into from
May 19, 2022
Merged

Update to "Styling text" section #17777

merged 3 commits into from
May 19, 2022

Conversation

LRANUL
Copy link
Contributor

@LRANUL LRANUL commented May 12, 2022

  • Added writing superscript syntax on GitHub markdowns for inline text to be displayed as superscript
  • Added writing subscript syntax on GitHub markdowns for inline text to be displayed as subscript

Reference Issue: #17618

Why:

For improving GitHub's user experience by allowing scientistic communities to use notations as in-text, this allows easier interactions compared to images.

Closes Issue #17618

What's being changed:

Changes will be made to Styling text section of the page, new addition will improve the overall GitHub experience by helping scientistic communities to use scientific and mathematical notations effortlessly.
e.g.

  1. The chemical notation of water could be interpreted as H2O by writing as H<sub>2</sub>O
  2. The mathematical equation of Pythagorean could be interpreted as a2+ b2 = c2 by writing as a<sup>2</sup>+ b<sup>2</sup> = c<sup>2</sup>
Updates
  • Added writing superscript syntax on GitHub markdowns for inline text to be displayed as superscript
  • Added writing subscript syntax on GitHub markdowns for inline text to be displayed as subscript
Notes

This information will support communities to use majority of notions used in the science as intext writing compared to images uploaded, for a complete coverage GitHub's internal features will need to improved in the future as the system is upgraded.

Screenshot

image

Check off the following:

  • I have reviewed my changes in staging (look for "Automatically generated comment" and click Modified to view your latest changes).
  • 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")

- Added writing superscript syntax on GitHub markdowns for inline text to be displayed as superscript
- Added writing subscript syntax on GitHub markdowns for inline text to be displayed as subscript

Reference Issue: #17618
@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label May 12, 2022
@github-actions
Copy link
Contributor

github-actions bot commented May 12, 2022

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/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax.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

@ramyaparimi ramyaparimi 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 get started Content related to "Getting Started" doc set and removed triage Do not begin working on this issue until triaged by the team labels May 12, 2022
@ramyaparimi
Copy link
Contributor

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

Copy link
Contributor

@skedwards88 skedwards88 left a comment

Choose a reason for hiding this comment

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

Thanks for this addition! We'll merge this down for you.

@skedwards88 skedwards88 added the ready to merge This pull request is ready to merge label May 14, 2022
@janiceilene janiceilene merged commit 362eb99 into github:main May 19, 2022
@github-actions
Copy link
Contributor

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

@LRANUL LRANUL deleted the patch-2 branch May 19, 2022 12:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content This issue or pull request belongs to the Docs Content team get started Content related to "Getting Started" doc set 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
Development

Successfully merging this pull request may close these issues.

Suggested: update to GitHub's markdown support for Basic writing and formatting syntax section
4 participants