diff options
| author | Norwid Behrnd <nbehrnd@yahoo.com> | 2022-11-30 14:22:46 +0100 |
|---|---|---|
| committer | Norwid Behrnd <nbehrnd@yahoo.com> | 2022-11-30 14:22:46 +0100 |
| commit | eddf5accb885230940aa8d7c9a3375755d057e7b (patch) | |
| tree | a3ca023963aadffa95fd5eb5c82601e87551aad5 /CONTRIBUTING.markdown | |
| parent | 7cf9a2b7aaab2829e7dcb28d082e4e4fab74336f (diff) | |
additional polish with markdownlint
Accounts for most of the remaining suggestions by markdownlint.[1]
[1] https://github.com/markdownlint/markdownlint, version 0.12.0.
Diffstat (limited to 'CONTRIBUTING.markdown')
| -rw-r--r-- | CONTRIBUTING.markdown | 13 |
1 files changed, 8 insertions, 5 deletions
diff --git a/CONTRIBUTING.markdown b/CONTRIBUTING.markdown index a3d75101..3d2853c6 100644 --- a/CONTRIBUTING.markdown +++ b/CONTRIBUTING.markdown @@ -37,7 +37,6 @@ review them more effectively and/or individually. `file language.html.markdown` You will see this if it uses a BOM: `UTF-8 Unicode (with BOM) text`. - ### Header configuration The actual site uses Middleman to generate HTML files from these Markdown ones. @@ -56,7 +55,7 @@ Other fields: *tool* or *Algorithms & Data Structures*. Defaults to *language* if omitted. * **filename**: The filename for this article's code. It will be fetched, mashed together, and made downloadable. - * For non-English articles, *filename* should have a language-specific + * For non-English articles, *filename* should have a language-specific suffix. * **lang**: For translations, the human language this article is in. For categorization, mostly. @@ -85,8 +84,12 @@ addition or not. You can build the site locally to test your changes. Follow the steps below. -* Install Ruby language runtime and RubyGems. See [here](https://middlemanapp.com/basics/install/) for more details. -* Clone or zip download the [learnxinyminutes-site](https://github.com/adambard/learnxinyminutes-site) repo. +* Install Ruby language runtime and RubyGems. See + [here](https://middlemanapp.com/basics/install/) + for more details. +* Clone or zip download the + [learnxinyminutes-site](https://github.com/adambard/learnxinyminutes-site) + repository. * `git clone https://github.com/adambard/learnxinyminutes-site` * Install Middleman and other required dependencies using Bundler. * `cd learnxinyminutes-site/` @@ -100,6 +103,6 @@ You can build the site locally to test your changes. Follow the steps below. * `cd source/docs/` * `git clone https://github.com/YOUR-USERNAME/learnxinyminutes-docs ./source/docs/` * Build the site or run a development server to test your changes (NOTE: run -these commands at `learnxinyminutes-site/`). + these commands at `learnxinyminutes-site/`). * Build - `bundle exec middleman build` * Dev server - `bundle exec middleman --force-polling --verbose` |