From 9f6dc0e2add986f3708f330c1a6d427a9bdb2916 Mon Sep 17 00:00:00 2001 From: Frieder Bluemle Date: Mon, 23 Apr 2018 14:03:12 +0800 Subject: [PATCH 1/2] Fix whitespace errors and GitHub spelling --- README.md | 8 ++++---- public/google61d87d1e4be3a9c2.html | 2 +- public/javascripts/parse.js | 12 ++++++------ public/stylesheets/style.styl | 2 +- routes/index.js | 2 +- sample_text.md | 10 +++++----- views/index.jade | 2 +- 7 files changed, 19 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index ad95360..0fbb3cd 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ -Github Markdown Scratchpad +GitHub Markdown Scratchpad ========================== -This is a quick side-by-side markdown editor using Github flavored markdown. It uses [Marked](https://github.com/chjj/marked) for markup generation. There are still a handful of issues between marked and true github flavored markdown but it's a very close approximation. +This is a quick side-by-side markdown editor using GitHub flavored markdown. It uses [Marked](https://github.com/chjj/marked) for markup generation. There are still a handful of issues between marked and true GitHub flavored markdown but it's a very close approximation. Demo ---- @@ -20,6 +20,6 @@ node app.js Please Don't Sue Me ------------------- -The CSS is copied from github's site wholesale to give the text the appropriate look and feel. +The CSS is copied from GitHub's site wholesale to give the text the appropriate look and feel. -This project is not affiliated with Github in any way, shape, or form. +This project is not affiliated with GitHub in any way, shape, or form. diff --git a/public/google61d87d1e4be3a9c2.html b/public/google61d87d1e4be3a9c2.html index 51bbe88..0ed6b1d 100644 --- a/public/google61d87d1e4be3a9c2.html +++ b/public/google61d87d1e4be3a9c2.html @@ -1 +1 @@ -google-site-verification: google61d87d1e4be3a9c2.html \ No newline at end of file +google-site-verification: google61d87d1e4be3a9c2.html diff --git a/public/javascripts/parse.js b/public/javascripts/parse.js index d371bf0..f5b4208 100644 --- a/public/javascripts/parse.js +++ b/public/javascripts/parse.js @@ -4,7 +4,7 @@ var renderers = { }; var currentRenderer = 'local'; -var remainingGithub = '?'; +var remainingGitHub = '?'; $(function() { var htmlTarget = $('#htmlTarget'); @@ -33,9 +33,9 @@ $(function() { htmlTarget.html(data); var rateLimit = request.getResponseHeader('X-RateLimit-Remaining'); if(rateLimit) { - remainingGithub = rateLimit; + remainingGitHub = rateLimit; } - renderGithubRateLimit(); + renderGitHubRateLimit(); }, error: function(data, textStatus){ console.error(data, textStatus); @@ -46,9 +46,9 @@ $(function() { var debouncedMarkdownChanged = _.debounce(markdownChanged, 300); markdownChanged(); - var renderGithubRateLimit = function() { + var renderGitHubRateLimit = function() { console.log(""); - $('.githubRateLimit').text(remainingGithub + " Github API calls remaining in this hour."); + $('.githubRateLimit').text(remainingGitHub + " GitHub API calls remaining in this hour."); }; var setRenderer = function(name) { @@ -59,7 +59,7 @@ $(function() { $('#markdownSource').bind('keyup change', debouncedMarkdownChanged); } else { $('#markdownSource').unbind(); - renderGithubRateLimit(); + renderGitHubRateLimit(); } }; diff --git a/public/stylesheets/style.styl b/public/stylesheets/style.styl index ebb478a..2b2b0ef 100644 --- a/public/stylesheets/style.styl +++ b/public/stylesheets/style.styl @@ -31,7 +31,7 @@ body width: 47% display: block float: left - + textarea#markdownSource width: 100% min-height: 1200px diff --git a/routes/index.js b/routes/index.js index 743113a..e99fb56 100644 --- a/routes/index.js +++ b/routes/index.js @@ -7,7 +7,7 @@ exports.index = function(req, res){ console.error("Could not open file: %s", err); } res.render('index', { - title: 'Github Markdown Scratchpad', + title: 'GitHub Markdown Scratchpad', sample_text: data }); }); diff --git a/sample_text.md b/sample_text.md index b5cdded..eebc643 100644 --- a/sample_text.md +++ b/sample_text.md @@ -1,15 +1,15 @@ -Github Markdown Scratchpad +GitHub Markdown Scratchpad ========================== -This is a quick side-by-side markdown editor using Github flavored markdown. It uses [Marked](https://github.com/chjj/marked) for markup generation. There are still a handful of issues between marked and true github flavored markdown but it's a very close approximation. +This is a quick side-by-side markdown editor using GitHub flavored markdown. It uses [Marked](https://github.com/chjj/marked) for markup generation. There are still a handful of issues between marked and true GitHub flavored markdown but it's a very close approximation. -If you'd like to contribute feel free to submit pull requests and issues via the [github repo](https://github.com/pcorliss/github-scratchpad). +If you'd like to contribute feel free to submit pull requests and issues via the [GitHub repo](https://github.com/pcorliss/github-scratchpad). If you have questions please feel free to send me an email. [pcorliss@gmail.com](mailto:pcorliss@gmail.com) -The CSS is copied from github's site wholesale to give the text the appropriate look and feel. +The CSS is copied from GitHub's site wholesale to give the text the appropriate look and feel. -This page is not affiliated with github in any way shape or form. +This page is not affiliated with GitHub in any way shape or form. GitHub Flavored Markdown ================================ diff --git a/views/index.jade b/views/index.jade index af9bcdd..14f95b2 100644 --- a/views/index.jade +++ b/views/index.jade @@ -7,7 +7,7 @@ block content a.brand= title .nav-collapse.collapse ul.nav - a.contribute(href="https://github.com/pcorliss/github-scratchpad") Contribute on Git + a.contribute(href="https://github.com/pcorliss/github-scratchpad") Contribute on GitHub .container-fluid .row-fluid From 14481cae153d6d6fa5f0b609a6dde4b04a3d1fa2 Mon Sep 17 00:00:00 2001 From: Frieder Bluemle Date: Mon, 23 Apr 2018 14:08:30 +0800 Subject: [PATCH 2/2] Fix markdownlint errors and update README.md This fixes all markdownlint errors excluding the original sample document. --- README.md | 25 ++++++++++++++----------- sample_text.md | 21 +++++++++++++-------- 2 files changed, 27 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 0fbb3cd..268f6a8 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,18 @@ -GitHub Markdown Scratchpad -========================== +# GitHub Markdown Scratchpad -This is a quick side-by-side markdown editor using GitHub flavored markdown. It uses [Marked](https://github.com/chjj/marked) for markup generation. There are still a handful of issues between marked and true GitHub flavored markdown but it's a very close approximation. +This is a quick side-by-side markdown editor using GitHub flavored markdown. It uses +[Marked](https://github.com/chjj/marked) for markup generation. There are still +a handful of issues between marked and true GitHub flavored markdown but it's a +very close approximation. -Demo ----- +See also [Writing on GitHub](https://help.github.com/categories/writing-on-github/) -http://github-scratchpad.herokuapp.com/ +## Demo + +[GitHub Markdown Scratchpad](http://github-scratchpad.herokuapp.com/) + +## Installation -Installation ------------- ``` git clone git://github.com/pcorliss/github-scratchpad.git cd github-scratchpad @@ -17,9 +20,9 @@ npm install node app.js ``` -Please Don't Sue Me -------------------- +## Please Don't Sue Me -The CSS is copied from GitHub's site wholesale to give the text the appropriate look and feel. +The CSS is copied from GitHub's site wholesale to give the text the appropriate +look and feel. This project is not affiliated with GitHub in any way, shape, or form. diff --git a/sample_text.md b/sample_text.md index eebc643..7f92a80 100644 --- a/sample_text.md +++ b/sample_text.md @@ -1,21 +1,26 @@ -GitHub Markdown Scratchpad -========================== +# GitHub Markdown Scratchpad -This is a quick side-by-side markdown editor using GitHub flavored markdown. It uses [Marked](https://github.com/chjj/marked) for markup generation. There are still a handful of issues between marked and true GitHub flavored markdown but it's a very close approximation. +This is a quick side-by-side markdown editor using GitHub flavored markdown. It +uses [Marked](https://github.com/chjj/marked) for markup generation. There are +still a handful of issues between Marked and true GitHub flavored markdown but +it's a very close approximation. -If you'd like to contribute feel free to submit pull requests and issues via the [GitHub repo](https://github.com/pcorliss/github-scratchpad). +If you'd like to contribute feel free to submit pull requests and issues via the +[GitHub repo](https://github.com/pcorliss/github-scratchpad). -If you have questions please feel free to send me an email. [pcorliss@gmail.com](mailto:pcorliss@gmail.com) +If you have questions please feel free to send me an email. +[pcorliss@gmail.com](mailto:pcorliss@gmail.com) -The CSS is copied from GitHub's site wholesale to give the text the appropriate look and feel. +The CSS is copied from GitHub's site wholesale to give the text the appropriate look +and feel. This page is not affiliated with GitHub in any way shape or form. +The section below was originally posted at https://github.com/mojombo/github-flavored-markdown/issues/1 + GitHub Flavored Markdown ================================ -Originally from https://github.com/mojombo/github-flavored-markdown/issues/1 - *View the [source of this content](http://github.github.com/github-flavored-markdown/sample_content.html).* Let's get the whole "linebreak" thing out of the way. The next paragraph contains two phrases separated by a single newline character: