Code documentation written as code! How novel and totally my idea!
Go to file
NickPapanastasiou 4b35798f83 more D
2015-06-10 11:54:25 -04:00
de-de Update python-de.html.markdown 2015-03-03 12:20:57 +01:00
es-es haml-es 2015-01-20 23:16:35 -03:00
fa-ir [javascript/*] typeof is an operand and not a function/method - fix usage / remove parens 2014-08-09 21:41:12 +02:00
fr-fr Refactor r french translation 2015-05-18 00:03:52 -03:00
hu-hu fixed orthographic and grammar mistakes 2014-03-07 07:38:07 +01:00
id-id fix syntax error 2014-03-14 18:19:06 +00:00
it-it fixed C++/it typos 2015-05-09 19:18:04 -07:00
ja-jp [julia/ja] Added missing lang: ja-jp 2015-01-13 09:29:15 +09:00
ko-kr Capitalize language names for translations. 2014-10-12 14:24:42 -07:00
nl-nl Merge pull request #820 from Jell-E/master 2014-10-28 23:03:03 +02:00
pl-pl Add @ukom Polish Perl translation from PR https://github.com/adambard/learnxinyminutes-docs/pull/341 2014-10-17 21:19:08 -05:00
pt-br Merge pull request #1033 from suuuzi/master 2015-04-05 11:13:35 -05:00
pt-pt Fixing some typos in Git pt-pt translation 2015-02-04 13:15:42 -02:00
ro-ro fixed typos, a little bit of formatting 2014-05-07 18:53:23 +02:00
ru-ru Update python3-ru.html.markdown 2015-04-07 12:30:52 +03:00
tr-tr Markdown tr-tr language 2015-03-30 21:26:26 +00:00
vi-vn Fix Vietnamese Git guide typo and update content 2014-10-25 09:59:01 +07:00
zh-cn Merge pull request #1102 from Alwayswithme/bash-cn 2015-06-02 13:20:29 -07:00
amd.html.markdown Attempt at fixing amd file's markdown on site. 2014-10-18 13:19:07 -05:00
asymptotic-notation.html.markdown Renamed Big-Oh to more prevalent notation, Big-O. 2015-03-04 17:48:10 -06:00
bash.html.markdown fixed spelling error 2015-05-26 11:25:07 +10:00
brainfuck.html.markdown Change link format 2015-03-24 22:24:49 +02:00
c.html.markdown c.html: fix #1021 (bitwise negation and shifting into the sign bit) 2015-03-30 10:11:05 +03:00
c++.html.markdown Updated other exception to also be runtime_error type instead. 2015-06-02 19:14:52 -04:00
clojure-macros.html.markdown Fixed spelling of 'arithmetic' in Clojure Macros tutorial. 2015-04-19 14:03:21 -07:00
clojure.html.markdown Update clojure.html.markdown 2015-05-13 11:00:57 +02:00
coffeescript.html.markdown Fixed very small spelling mistake 2014-09-14 13:18:43 -06:00
common-lisp.html.markdown fix the while macro for Common Lisp 2015-04-21 15:08:39 -04:00
compojure.html.markdown Use keywords in POST/PUT examples 2015-05-30 11:43:37 -06:00
csharp.html.markdown [CSharp/en]Fixed typo 2015-02-01 19:01:47 +01:00
css.html.markdown corrected definition of ~ selector, added | 2015-02-19 00:15:12 +05:30
d.html.markdown more D 2015-06-10 11:54:16 -04:00
dart.html.markdown Authors -> Contributors 2013-07-03 22:59:13 -07:00
elisp.html.markdown editorial revert of a change, remove trailing whitespace 2015-05-22 23:05:37 +02:00
elixir.html.markdown Add ranges under 'Basic types' 2015-02-01 01:32:21 +13:00
erlang.html.markdown [erlang/en] Clarify bit about guard sequences 2015-05-28 09:28:41 +02:00
file.erb Added filename parameter 2013-06-29 20:19:14 -07:00
forth.html.markdown Update forth.html.markdown 2015-01-02 20:33:47 +00:00
fsharp.html.markdown Authors -> Contributors 2013-07-03 22:59:13 -07:00
git.html.markdown Added the handy -a switch 2015-03-04 22:00:00 +05:30
go.html.markdown Fallthrough 2015-04-23 00:02:33 +10:00
groovy.html.markdown Corrected link to Groovy documentatin 2015-06-07 12:06:05 -05:00
hack.html.markdown [hack/en] Fix link to other learnxinyminutes article 2015-02-18 19:23:58 +13:00
haml.html.markdown Added info on indentation and escaping html, typos 2014-10-18 12:25:42 +01:00
haskell.html.markdown Fixed haskell foldr example 2015-04-27 10:16:16 +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 Further improve for loop description. 2015-05-26 20:21:43 +01:00
javascript.html.markdown [javascript/zh] Translation tracking 2015-03-06 17:42:44 +08:00
json.html.markdown Fix Markdown 2015-05-03 20:55:14 +02:00
julia.html.markdown [julia/en] Update for Julia 0.3 and fix a few typos 2015-05-02 22:26:12 -07:00
livescript.html.markdown Update livescript.html.markdown 2014-12-24 10:38:16 +01:00
lua.html.markdown Capitalize language names. See #137 2014-10-12 12:24:52 -07:00
markdown.html.markdown Add a couple missing parts to the markdown doc from @ukom PR https://github.com/adambard/learnxinyminutes-docs/pull/341 2014-10-17 21:09:51 -05:00
matlab.html.markdown Temp fix for Matlab syntax highlighting 2014-11-18 10:19:11 +00:00
neat.html.markdown Fixed up so it builds 2013-09-08 22:52:09 -07:00
nim.html.markdown Fix copy-paste typo. 2015-05-18 14:19:46 +05:00
objective-c.html.markdown Further fix of typos in objective-c doc 2015-01-31 22:18:02 -05:00
ocaml.html.markdown [ocaml/en] Fix typo 2015-02-12 17:02:16 +08:00
paren.html.markdown link to racket 2014-05-26 18:04:02 +02:00
perl6.html.markdown Parrot is no longer supported. 2015-05-13 12:20:54 +12:00
perl.html.markdown Shortens line lengths of comments in Perl guide 2014-06-10 10:06:08 -07:00
pets.csv Create pets.csv 2013-06-29 03:38:34 -04:00
php.html.markdown add ; to php/en 2015-05-14 21:30:15 +00:00
pogo.html.markdown Fixed typo at the end 2014-12-22 13:26:30 +01:00
purescript.html.markdown Learn Purescript in Y minutes 2014-08-31 23:26:56 +02:00
python3.html.markdown Python3 doc cleanup 2015-04-30 23:44:09 -06:00
python.html.markdown Clarify wording for list reversal. 2015-04-30 19:31:38 -04:00
r.html.markdown Add definition of parakeet in r.html.markdown 2015-01-28 23:27:09 -06:00
racket.html.markdown detailed explanation of eq?, eqv?, and equal? 2015-03-13 14:04:20 -04:00
README.markdown Update README.markdown 2014-12-08 23:42:24 +01:00
red.html.markdown Update red.html.markdown 2014-02-07 20:34:08 +01:00
ruby-ecosystem.html.markdown [ruby-ecosystem/en] 'ruby' -> 'Ruby' (cont. cont.) 2014-07-07 21:50:27 +01:00
ruby.html.markdown add to ruby contributors 2015-03-19 15:38:27 +05:30
rust.html.markdown Updating rust.html.markdown for Rust 1.0 2015-05-15 17:12:45 -05:00
scala.html.markdown make corrections 2015-04-16 17:53:40 +08:00
self.html.markdown Update self.html.markdown 2014-10-31 00:44:24 +02:00
standard-ml.html.markdown Fix indentation 2015-06-06 12:53:33 -04:00
swift.html.markdown add optional init and enum with associated values 2015-02-28 19:28:34 +08:00
tcl.html.markdown [tcl/en] Fix typos 2015-03-09 13:57:30 +08: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 An assortment 2013-08-01 11:24:23 -07:00
whip.html.markdown Little typos fixed. 2014-08-12 20:35:42 -05:00
xml.html.markdown Update xml.html.markdown 2015-03-11 17:38:42 -07: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.