Code documentation written as code! How novel and totally my idea!
Go to file
Robson Alves da6fc10553 Include and correct csharp docs
Correct the csharp doc en-us language which was written intialize to
initialize and include new more translated words to pt-br language.
2015-10-12 07:03:18 -03:00
cs-cz Add lang: to header of Python3 cs-cz file. 2015-10-01 09:39:00 -05:00
de-de 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
el-gr fix some sentences left in english 2015-08-16 23:26:23 +03:00
es-es replace author_url with github link 2015-10-10 21:41:42 +02:00
fa-ir 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
fr-fr Merge pull request #1450 from Gnomino/master 2015-10-11 20:22:50 +02:00
hu-hu Ruby hungarian translation 2015-10-09 02:41:08 +02:00
id-id Fix #1289 2015-10-04 22:44:34 +02:00
it-it Merge pull request #1240 from kino90/coffeescript 2015-09-19 20:20:22 -06: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
nl-nl Fix dutch notation for large numbers 2015-10-07 11:36:24 +02:00
no-nb translating done 2015-04-26 16:22:36 +02:00
pl-pl [brainfuck/pl] translated from en 2015-09-02 14:41:50 +02:00
pt-br Include and correct csharp docs 2015-10-12 07:03:18 -03: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 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
tr-tr Put demonstrative condition into ternary expression 2015-10-04 21:56:24 +02:00
vi-vn Fix Vietnamese Git guide typo and update content 2014-10-25 09:59:01 +07:00
zh-cn 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
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 removing whitespace all over 2015-10-07 23:11:24 -04:00
brainfuck.html.markdown Change link format 2015-03-24 22:24:49 +02:00
c.html.markdown Revert "[c/en] Added a section for header files." 2015-10-07 23:49:46 -04:00
c++.html.markdown Update c++.html.markdown 2015-10-07 01:27:12 +04:00
chapel.html.markdown Typo: "thought of" not "though of" 2015-10-08 07:14:24 -04:00
clojure-macros.html.markdown removing whitespace all over 2015-10-07 23:11:24 -04:00
clojure.html.markdown Update clojure.html.markdown 2015-05-13 11:00:57 +02:00
coffeescript.html.markdown Merge pull request #1424 from AndyBrown91/coffeescript 2015-10-09 20:00:54 +02:00
common-lisp.html.markdown removing whitespace all over 2015-10-07 23:11:24 -04:00
compojure.html.markdown Use keywords in POST/PUT examples 2015-05-30 11:43:37 -06:00
csharp.html.markdown Include and correct csharp docs 2015-10-12 07:03:18 -03:00
css.html.markdown removing whitespace all over 2015-10-07 23:11:24 -04:00
d.html.markdown removing whitespace all over 2015-10-07 23:11:24 -04:00
dart.html.markdown removing whitespace all over 2015-10-07 23:11:24 -04:00
elisp.html.markdown editorial revert of a change, remove trailing whitespace 2015-05-22 23:05:37 +02:00
elixir.html.markdown Fix typo in elixer 2015-06-24 10:50:39 -07:00
erlang.html.markdown removing whitespace all over 2015-10-07 23:11:24 -04: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 Typo: "easily" rather than "easy" 2015-10-08 09:00:59 -04:00
git.html.markdown Git: Add Git Immersion tutorial as a resource 2015-10-08 19:18:07 -04:00
go.html.markdown Added suggested changes 2015-10-08 23:24:25 -04:00
groovy.html.markdown Update groovy.html.markdown 2015-10-06 16:49:21 -03:00
hack.html.markdown removing whitespace all over 2015-10-07 23:11:24 -04:00
haml.html.markdown removing whitespace all over 2015-10-07 23:11:24 -04:00
haskell.html.markdown change haskell's operator $ description wording 2015-07-06 10:40:05 +02: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 Fix conflicts from merge with master 2015-10-09 11:19:17 -04:00
javascript.html.markdown Merge pull request #1372 from raphaelbn/patch-1 2015-10-09 10:02:12 -05:00
json.html.markdown [json/en] Typo 2015-10-09 11:27:19 +02:00
julia.html.markdown try to make string change clearer 2015-10-10 14:34:55 -04:00
livescript.html.markdown removing whitespace all over 2015-10-07 23:11:24 -04:00
lua.html.markdown Capitalize language names. See #137 2014-10-12 12:24:52 -07:00
make.html.markdown removing whitespace all over 2015-10-07 23:11:24 -04:00
markdown.html.markdown removing whitespace all over 2015-10-07 23:11:24 -04:00
matlab.html.markdown [matlab/en] Added simple class example to Matlab 2015-10-08 21:20:37 +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 removing whitespace all over 2015-10-07 23:11:24 -04:00
ocaml.html.markdown removing whitespace all over 2015-10-07 23:11:24 -04:00
paren.html.markdown link to racket 2014-05-26 18:04:02 +02:00
perl6.html.markdown Many fixes mentioned in #1390 2015-10-10 13:58:25 -04: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 #1385 from gayanhewa/master 2015-10-09 10:05:11 -05:00
pogo.html.markdown Fixed typo at the end 2014-12-22 13:26:30 +01:00
purescript.html.markdown removing whitespace all over 2015-10-07 23:11:24 -04:00
python3.html.markdown Changed way of creating classes 2015-10-11 13:47:44 +02:00
python.html.markdown Add examples of higher-order functions taking multiple arguments 2015-10-07 17:01:28 +11:00
r.html.markdown removing whitespace all over 2015-10-07 23:11:24 -04:00
racket.html.markdown removing whitespace all over 2015-10-07 23:11:24 -04:00
README.markdown Update README.markdown 2014-12-08 23:42:24 +01: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 #1374 from kalebdavis/patch-2 2015-10-09 10:02:59 -05:00
rust.html.markdown removing whitespace all over 2015-10-07 23:11:24 -04:00
sass.html.markdown Corrected extension 2015-10-11 09:52:30 -04:00
scala.html.markdown Fix compile errors of the English and French Scala tutorials 2015-10-10 16:49:53 +01: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 Merge pull request #1381 from cwalk/swift-2 2015-10-09 10:08:24 -05:00
tcl.html.markdown removing whitespace all over 2015-10-07 23:11:24 -04:00
tmux.html.markdown Update tmux.html.markdown 2015-04-19 10:59:11 +08:00
typescript.html.markdown [typescript/en] Fix typo 2015-04-21 23:01:08 +03:00
visualbasic.html.markdown removing whitespace all over 2015-10-07 23:11:24 -04:00
whip.html.markdown Little typos fixed. 2014-08-12 20:35:42 -05:00
xml.html.markdown [xml/en] Grammar fixes 2015-10-09 16:05:21 +01:00
yaml.html.markdown [yaml/cn]: add last translation 2014-06-01 09:39:22 -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 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, required 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.