Code documentation written as code! How novel and totally my idea!
Go to file
Cedric HT 8cff05396e Corrected header
Added myself as translator.
2016-01-18 12:16:37 +01:00
cs-cz Merge branch 'master' of github.com:adambard/learnxinyminutes-docs 2016-01-08 14:35:53 +08:00
de-de Merge pull request #1957 from jmeinke/latex-de 2016-01-04 13:51:36 -07:00
el-gr Update scala-gr.html.markdown 2015-10-18 00:02:18 +03:00
es-es Update latex-es.html.markdown 2016-01-06 04:13:33 +08:00
fa-ir Rename javascript.html.markdown to javascript-fa.html.markdown 2015-10-28 02:17:06 +08:00
fi-fi Translate en/Markdown to Finnish 2015-11-11 15:39:16 +02:00
fr-fr Corrected header 2016-01-18 12:16:37 +01:00
hu-hu Merge pull request #1873 from ditam/yaml_hun 2016-01-08 13:30:26 -07:00
id-id Update xml-id.html.markdown 2015-10-21 20:36:50 +08:00
it-it Merge pull request #1294 from Ale46/master 2015-12-21 15:19:35 -05:00
ja-jp [julia/ja] Added missing lang: ja-jp 2015-01-13 09:29:15 +09:00
ko-kr Fix for issue #1248 [fa-ir, zh-cn, ko-kr, es-es, ru-ru, fr-fr, de-de] 2015-10-05 15:20:35 -05:00
lt-lt small fix 2015-11-11 15:21:56 +02:00
ms-my [JSON/ms-my] Added Malay (Malaysia) translation for JSON 2015-10-31 23:39:21 +08:00
nl-nl Added Dutch translation of AMD. 2015-10-31 12:37:39 +01:00
no-nb translating done 2015-04-26 16:22:36 +02:00
pl-pl Remove incorrect list indentation in perl-pl 2015-12-17 16:54:53 +01:00
pt-br Merge pull request #1967 from victor-dsc/javascript-fixing 2015-11-27 11:51:42 +07:00
pt-pt [scala-pt] Fix variable names on while cycle 2015-10-10 16:51:07 +01:00
ro-ro line length tweaking.. 2015-08-07 12:50:36 +03:00
ru-ru Merge pull request #1519 from whitebyte/master 2015-12-13 00:37:57 +02:00
sk-sk Translated latex to slovak 2015-11-19 17:59:11 +01:00
ta_in Rename xml.html.markdown to xml-ta.html.markdown 2015-10-28 02:16:12 +08:00
tr-tr Merge pull request #1965 from bureken/master 2016-01-03 14:00:10 -07:00
uk-ua Moved ua-ua files to uk-ua 2015-11-30 22:22:42 +07:00
vi-vn fix typo 2015-10-17 15:33:10 +07:00
zh-cn Merge pull request #2083 from Arnie97/master 2016-01-03 13:54:37 -07:00
zh-tw Fix typo 2015-12-17 01:51:19 +08:00
amd.html.markdown removing whitespace all over 2015-10-07 23:11:24 -04:00
asymptotic-notation.html.markdown removing whitespace all over 2015-10-07 23:11:24 -04:00
bash.html.markdown Use proper string comparison syntax 2016-01-12 00:32:03 +01:00
brainfuck.html.markdown Change link format 2015-03-24 22:24:49 +02:00
c.html.markdown typo 2015-12-24 23:24:09 +04:00
c++.html.markdown More Fixes 2016-01-08 01:21:38 +05:30
chapel.html.markdown Fix typos 2015-10-24 00:01:32 +02:00
clojure-macros.html.markdown removing whitespace all over 2015-10-07 23:11:24 -04:00
clojure.html.markdown Copy arrow docs from french. 2015-10-18 00:31:19 +08:00
coffeescript.html.markdown Merge pull request #1424 from AndyBrown91/coffeescript 2015-10-09 20:00:54 +02:00
coldfusion.html.markdown replaced < and > in pre block 2015-12-18 09:35:15 -06:00
common-lisp.html.markdown [common-lisp/en] Fix code in examples 2015-12-09 00:03:06 +03:00
compojure.html.markdown Use keywords in POST/PUT examples 2015-05-30 11:43:37 -06:00
csharp.html.markdown Merge pull request #1960 from roymiloh/master 2015-12-21 15:22:23 -05:00
css.html.markdown Revert "Closed a comment that was not properly closed" 2015-10-31 18:26:19 +08:00
d.html.markdown fix parallelism example typo 2016-01-02 18:43:19 +02:00
dart.html.markdown Update dart.html.markdown 2015-10-31 22:16:39 +01:00
edn.html.markdown [edn/en] Fix grammar 2015-10-31 15:35:33 -04:00
elisp.html.markdown Fixed small 'responsibility' typo in disclaimer 2015-10-23 23:21:00 -07:00
elixir.html.markdown elixir: add eval results to try-rescue examples 2015-11-04 23:28:26 -05:00
elm.html.markdown Mention unit; line breaks for style 2015-12-16 19:55:33 -05:00
erlang.html.markdown Replaced 'or' with a semicolons 2015-11-19 15:51:08 +03:00
factor.html.markdown Rename factor.html to factor.html.markdown 2016-01-01 01:54:45 +00:00
file.erb Added filename parameter 2013-06-29 20:19:14 -07:00
forth.html.markdown Merge pull request #1433 from zlarsen/forth-typo 2015-10-09 23:25:22 +02:00
fsharp.html.markdown Merge pull request #1764 from amrue/fsharp 2015-11-02 19:07:44 +08:00
git.html.markdown Adds documentation for revert command 2015-10-30 19:58:33 +00:00
go.html.markdown correct minor grammar and formatting to improve readability 2015-10-24 13:56:20 +01:00
groovy.html.markdown Merge pull request #2060 from ilmoralito/master 2016-01-06 03:54:32 +08:00
hack.html.markdown removing whitespace all over 2015-10-07 23:11:24 -04:00
haml.html.markdown Merge pull request #1438 from chashmeetsingh/patch-8 2015-10-12 23:07:44 -05:00
haskell.html.markdown Updating dev environment installation info 2015-12-03 14:27:24 -08:00
haxe.html.markdown [haxe/en] Adding colon after comments 2015-05-20 14:29:05 +02:00
hy.html.markdown Changed function name to match function call 2014-12-16 22:33:08 +05:30
java.html.markdown Merge pull request #1698 from chaityabshah/master 2015-12-18 17:32:27 -05:00
javascript.html.markdown Added new resource to javascript 2015-10-31 16:49:57 -07:00
json.html.markdown [json/en] Cut noise, formatting, links. 2015-10-20 14:24:32 +05:30
julia.html.markdown Add different array declaration syntax 2015-12-28 21:43:09 +05:30
latex.html.markdown [latex/en] Cleanup of pdf file after previous commit 2015-11-10 22:26:17 -08:00
less.html.markdown [less/en] Add Less tutorial, similar to sass 2015-10-31 22:55:11 -07:00
livescript.html.markdown removing whitespace all over 2015-10-07 23:11:24 -04:00
lua.html.markdown [elisp/en] Fix typo 2015-10-28 13:16:13 +05:30
make.html.markdown Update make.html.markdown 2015-10-30 01:20:12 -04:00
markdown.html.markdown unfuck markdown doc 2016-01-08 14:35:16 +08:00
matlab.html.markdown Merge pull request #1770 from navdeep300/master 2015-12-02 22:20:13 +02:00
neat.html.markdown removing whitespace all over 2015-10-07 23:11:24 -04:00
nim.html.markdown Sugar Assert fix 2015-10-07 21:19:50 -04:00
objective-c.html.markdown Update contributor list 2015-11-01 01:48:44 +01:00
ocaml.html.markdown Update ocaml.html.markdown 2015-10-17 15:06:28 +03:00
paren.html.markdown link to racket 2014-05-26 18:04:02 +02:00
perl6.html.markdown Fix typo referenced in Issue #2075 2016-01-07 22:08:17 -07:00
perl.html.markdown Add example of post-condition for loop. 2015-10-10 11:44:50 -07:00
pets.csv Create pets.csv 2013-06-29 03:38:34 -04:00
php.html.markdown Merge pull request #1964 from lesaff/patch-1 2016-01-06 04:05:23 +08:00
pogo.html.markdown Fixed typo at the end 2014-12-22 13:26:30 +01:00
powershell.html.markdown [PowerShell/en]: fixed typos/layout. Added some extra aliases/info. 2016-01-08 19:52:33 +01:00
purescript.html.markdown readded haskell syntax highlighting, added line about running examples in psci, removed >'s 2015-10-13 01:25:56 -07:00
python3.html.markdown Changed a to b in comment about list assignment, and pluralized 'variable'. 2016-01-10 17:22:32 -07:00
python.html.markdown Merge pull request #1790 from jxu093/master 2015-12-18 17:30:53 -05:00
pythonstatcomp.html.markdown pep8 fixes (spaces and multiline statements) 2016-01-03 19:45:54 +01:00
r.html.markdown fix spaces at end-of-lines again 2015-10-20 17:10:58 -04:00
racket.html.markdown removing whitespace all over 2015-10-07 23:11:24 -04:00
README.markdown Fix typo in README.md 2015-10-25 12:55:50 -04:00
red.html.markdown removing whitespace all over 2015-10-07 23:11:24 -04:00
ruby-ecosystem.html.markdown Ruby 1.9.x is also retired 2015-10-06 16:08:41 +02:00
ruby.html.markdown Merge pull request #1800 from volcov/add-ruby-reference 2016-01-04 13:46:13 -07:00
rust.html.markdown Mention meaning of asterisk. Explain *ref_var2 2015-10-11 09:39:39 +05:30
sass.html.markdown [sass/en] Cleaning up wording and formatting 2015-10-29 10:05:36 -04:00
scala.html.markdown Merge pull request #1802 from juusaw/patch-3 2016-01-06 14:56:09 -07:00
self.html.markdown removing whitespace all over 2015-10-07 23:11:24 -04:00
smalltalk.html.markdown removing whitespace all over 2015-10-07 23:11:24 -04:00
standard-ml.html.markdown Fix indentation 2015-06-06 12:53:33 -04:00
swift.html.markdown Updated comment on documentation of Swift functions 2016-01-14 19:11:45 +01:00
tcl.html.markdown removing whitespace all over 2015-10-07 23:11:24 -04:00
tmux.html.markdown Update tmux home page, again. 2015-12-31 15:51:09 +08:00
typescript.html.markdown Merge pull request #1640 from adback03/master 2015-12-18 17:17:46 -05:00
visualbasic.html.markdown correction 2015-11-08 23:46:41 +03:00
whip.html.markdown [whip/en] Fix typos 2015-10-31 22:46:58 -04:00
wolfram.html.markdown Rename wolfram.md to wolfram.html.markdown 2016-01-01 01:54:11 +00:00
xml.html.markdown [xml/en] Grammar, formatting. Made more 'inlined'. 2015-10-20 13:53:47 +05:30
yaml.html.markdown Merge pull request #1966 from lesaff/patch-2 2015-11-27 11:49:26 +07:00
zfs.html.markdown Adding a putting it all together section, and some additional reading 2015-10-17 02:06:18 -07:00

Learn X in Y minutes

Whirlwind tours of (several, hopefully many someday) popular and ought-to-be-more-popular programming languages, presented as valid, commented code and explained as they go.

We need YOU!...

... to write more inline code tutorials. Just grab an existing file from this repo and copy the formatting (don't worry, it's all very simple). Make a new file, send a pull request, and if it passes muster I'll get it up pronto. Remember to fill in the "contributors" fields so you get credited properly!

Contributing

All contributions are welcome, from the tiniest typo to a brand new article. Translations in all languages are welcome (or, for that matter, original articles in any language). Send a pull request or open an issue any time of day or night.

Please tag your issues and pull requests with [language/lang-code] at the beginning (e.g. [python/en] for English Python). This will help everyone pick out things they care about.

We're happy for any contribution in any form, but if you're making more than one major change (i.e. translations for two different languages) it would be super cool of you to make a separate pull request for each one so that someone can review them more effectively and/or individually.

Style Guidelines

  • Keep lines under 80 chars
  • Prefer example to exposition
  • Eschew surplusage
  • Use UTF-8

Long version:

  • Try to keep line length in code blocks to 80 characters or fewer, or they'll overflow and look odd.

  • Try to use as few words as possible. Code examples are preferred over exposition in all cases.

  • We welcome newcomers, but the target audience for this site is programmers with some experience. So, try to avoid explaining basic concepts except for those specific to the language in question, to keep articles succinct and scannable. We all know how to use Google here.

  • For translations (or English articles with non-ASCII characters), please make sure your file is UTF-8 encoded, and try to leave out the byte-order-mark at the start of the file. (:set nobomb in Vim)

Header configuration

The actual site uses Middleman to generate HTML files from these Markdown ones. Middleman, or at least the custom scripts underpinning the site, requires that some key information be defined in the header.

The following fields are necessary for English articles about programming languages:

  • language The programming language in question
  • contributors A list of [author, URL] lists to credit

Other fields:

  • 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 suffix.
  • lang: For translations, the human language this article is in. For categorization, mostly.

Here's an example header for an Esperanto translation of Ruby:

---
language: ruby
filename: learnruby-epo.ruby
contributors:
    - ["Doktor Esperanto", "http://example.com/"]
    - ["Someone else", "http://someoneelseswebsite.com/"]
lang: ep-ep
---

License

Contributors retain copyright to their work, and can request removal at any time. By uploading a doc here, you agree to publish your work under the default Creative Commons Attribution-ShareAlike 3.0 Unported licensing included on each doc page.

Anything not covered by the above -- basically, this README -- you can use as you wish, I guess.