info/learnxinyminutes-docs
1
0
Fork 0
mirror of https://github.com/adambard/learnxinyminutes-docs.git synced 2025-08-13 10:14:58 +02:00
Code Issues Releases Wiki Activity

additional polish with markdownlint

Browse Source 
Accounts for most of the remaining suggestions by markdownlint.[1]

[1] https://github.com/markdownlint/markdownlint, version 0.12.0.
This commit is contained in:
Norwid Behrnd
2022-11-30 14:22:46 +01:00
parent 7cf9a2b7aa
commit eddf5accb8
1 changed files with 8 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
CONTRIBUTING.markdown
View File

@@ -37,7 +37,6 @@ review them more effectively and/or individually.
`file language.html.markdown` You will see this if it uses a BOM: `file language.html.markdown` You will see this if it uses a BOM:
`UTF-8 Unicode (with BOM) text`. `UTF-8 Unicode (with BOM) text`.
### Header configuration ### Header configuration
The actual site uses Middleman to generate HTML files from these Markdown ones. 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. *tool* or *Algorithms & Data Structures*. Defaults to *language* if omitted.
* **filename**: The filename for this article's code. It will be fetched, mashed * **filename**: The filename for this article's code. It will be fetched, mashed
together, and made downloadable. 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. suffix.
* **lang**: For translations, the human language this article is in. For * **lang**: For translations, the human language this article is in. For
categorization, mostly. categorization, mostly.
@@ -85,8 +84,12 @@ addition or not.
You can build the site locally to test your changes. Follow the steps below. 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. * Install Ruby language runtime and RubyGems. See
* Clone or zip download the [learnxinyminutes-site](https://github.com/adambard/learnxinyminutes-site) repo. [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` * `git clone https://github.com/adambard/learnxinyminutes-site`
* Install Middleman and other required dependencies using Bundler. * Install Middleman and other required dependencies using Bundler.
* `cd learnxinyminutes-site/` * `cd learnxinyminutes-site/`
@@ -100,6 +103,6 @@ You can build the site locally to test your changes. Follow the steps below.
* `cd source/docs/` * `cd source/docs/`
* `git clone https://github.com/YOUR-USERNAME/learnxinyminutes-docs ./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 * 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` * Build - `bundle exec middleman build`
* Dev server - `bundle exec middleman --force-polling --verbose` * Dev server - `bundle exec middleman --force-polling --verbose`