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

README: fix code blocks #462

Merged
merged 5 commits into from
Apr 16, 2021
Merged

README: fix code blocks #462

merged 5 commits into from
Apr 16, 2021

Conversation

jrfnl
Copy link
Member

@jrfnl jrfnl commented Mar 21, 2021

The homepage of the https://requests.ryanmccue.info/ website is automatically generated from the readme file.

The last time the site was generated was in 2016. Since then a lot has changed in GH Pages and a lot of the dependencies used to generate a site have been updated to newer releases.

Most notable, the kramdown engine has moved from v1 to v2 which has implications for how code blocks are shown on the website.

For the best results, it is strongly recommended to not use "whitespace" marked code blocks, but to use code block fencing with a language indicator to enable syntax highlighting as well.

This commit fixes up the README file in anticipation of the release.

@jrfnl jrfnl added this to the 1.8.0 milestone Mar 21, 2021
@jrfnl jrfnl requested a review from schlessera March 21, 2021 02:20
@codecov
Copy link

codecov bot commented Mar 21, 2021

Codecov Report

Merging #462 (190ddaf) into master (18cc33e) will decrease coverage by 0.11%.
The diff coverage is n/a.

Impacted file tree graph

@@             Coverage Diff              @@
##             master     #462      +/-   ##
============================================
- Coverage     93.06%   92.95%   -0.12%     
  Complexity      764      764              
============================================
  Files            21       21              
  Lines          1788     1788              
============================================
- Hits           1664     1662       -2     
- Misses          124      126       +2     
Impacted Files Coverage Δ Complexity Δ
library/Requests/Transport/fsockopen.php 93.78% <0.00%> (-0.57%) 69.00% <0.00%> (ø%)
library/Requests/Transport/cURL.php 94.23% <0.00%> (-0.49%) 67.00% <0.00%> (ø%)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 18cc33e...190ddaf. Read the comment docs.

@jrfnl jrfnl mentioned this pull request Mar 22, 2021
3 tasks
The homepage of the https://requests.ryanmccue.info/ website is automatically generated from the `readme` file.

The last time the site was generated was in 2016. Since then a lot has changed in GH Pages and a lot of the [dependencies](https://pages.github.com/versions/) used to generate a site have been updated to newer releases.

Most notable, the kramdown engine has moved from v1 to v2 which has implications for how code blocks are shown on the website.

For the best results, it is strongly recommended to not use "whitespace" marked code blocks, but to use code block fencing with a language indicator to enable syntax highlighting as well.

This commit fixes up the `README` file in anticipation of the release.
@schlessera schlessera merged commit 17e6afb into master Apr 16, 2021
@schlessera schlessera deleted the feature/fix-readme branch April 16, 2021 11:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants