Code documentation written as code! How novel and totally my idea!
Go to file
Andrew DiMola df0d0a2402
Update rst.html.markdown
Revising the section on creating lists with RST, as the syntax for list/sublist creation is not 1-1 with Markdown. 

The current example is actually incorrect—any/all sublists must be separated from their parent list by blank lines (above and below). These sublists must also be properly indented in relation to the text of the above parent list.

References: 
[1]: http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#bullet-lists
[2]: http://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html
2019-04-15 15:46:38 -04:00
ar-ar Learn python 3 in Y minutes Arabic translation 2019-02-08 01:43:07 +02:00
bg-bg Fix frontmatter 2018-10-24 22:42:04 +05:30
ca-es [groovy] small fix in iteration over a map 2017-10-04 16:15:38 +02:00
cs-cz Type correction for the output of math.sqrt() propagated across versions and languages 2019-02-06 07:31:34 +05:30
de-de [asciidoc/de] Added commas 2019-04-06 11:57:33 +02:00
el-gr Update json-gr.html.markdown 2018-11-17 10:21:39 +02:00
es-es Remove unused fields 2019-03-14 09:38:45 -07:00
fa-ir Add language code suffix(#2832) 2017-08-25 13:41:02 +05:45
fi-fi Fix build error in 'build/docs/fi-fi/markdown-fi/index.html' 2018-08-29 17:22:40 +05:30
fr-fr Move "make" articles to the "tool" category 2019-03-08 17:21:53 +01:00
hd-hd Metadata fixups for #1673 2016-06-26 14:33:01 +02:00
hu-hu Type correction for the output of math.sqrt() propagated across versions and languages 2019-02-06 07:31:34 +05:30
id-id Fix build error in 'error build/docs/id-id/markdown/index.html' 2018-08-29 17:24:00 +05:30
it-it Merge pull request #3458 from sanindya-iiitd/patch-1 2019-02-09 01:41:44 +02:00
ja-jp Fix a bunch of typos 2017-08-23 10:14:39 +02:00
ko-kr Type correction for the output of math.sqrt() propagated across versions and languages 2019-02-06 07:31:34 +05:30
lt-lt Add language code suffix(#2832) 2017-08-25 13:50:47 +05:45
ms-my [clojure-macros/ms-my] Fixed links 2018-10-30 22:30:47 -03:00
nl-nl [Dynamic programming - NL/NL] Fixed links 2018-10-31 18:16:41 -03:00
no-nb [bash/no-nb] removes to lines of english (#2641) 2017-01-31 08:46:07 +01:00
pl-pl Adding the file option 2019-03-16 07:35:09 +01:00
pt-br User data has to follow the grammar 2019-03-27 20:00:34 +01:00
pt-pt swift | fix style guidelines 2017-10-09 08:04:01 +02:00
ro-ro Type correction for the output of math.sqrt() propagated across versions and languages 2019-02-06 07:31:34 +05:30
ru-ru Аmended as requested 2019-03-14 21:48:23 +03:00
sk-sk Fix file names (#2987) 2017-11-06 18:34:48 +05:45
sl-si Add Slovenian translation for AsciiDoc 2018-12-14 18:39:08 +01:00
sv-se Merge pull request #3047 from edwtjo/nix-sv 2018-02-28 16:34:57 +05:45
ta_in fix language code suffix(#2832) 2017-08-25 14:14:30 +05:45
tests Reinstate test 2018-08-30 19:10:56 -07:00
tr-tr Update clojure-tr.html.markdown 2019-02-10 15:56:03 -08:00
uk-ua Type correction for the output of math.sqrt() propagated across versions and languages 2019-02-06 07:31:34 +05:30
vi-vn md 2018-08-24 19:44:16 -07:00
zh-cn Move "make" articles to the "tool" category 2019-03-08 17:21:53 +01:00
zh-tw Type correction for the output of math.sqrt() propagated across versions and languages 2019-02-06 07:31:34 +05:30
.gitattributes Add about 3/4 of the languages to gitattributes 2016-11-10 02:56:48 -08:00
.gitignore Updated, referencing #2185 2016-03-14 12:38:47 +05:30
.travis.yml Add support for checking YAML validity using Travis CI 2016-11-09 18:06:38 -08:00
amd.html.markdown removing whitespace all over 2015-10-07 23:11:24 -04:00
angularjs.html.markdown Update angularjs.html.markdown 2017-08-18 06:27:04 +02:00
ansible.html.markdown Update ansible.html.markdown 2018-11-17 14:38:50 -05:00
asciidoc.html.markdown [asciidoc/en][asciidoc/de][asciidoc/is][asciidoc/pt] fixed wrong 2017-09-21 18:57:11 +02:00
asymptotic-notation.html.markdown Fixes #3486 2019-02-26 17:12:57 +05:30
awk.html.markdown Move "awk" articles to the "tool" category 2019-03-08 17:19:27 +01:00
bash.html.markdown [bash/en] Fix line length 2018-12-24 00:59:11 +02:00
bf.html.markdown Update bf.html.markdown 2018-03-14 08:40:50 +05:45
c.html.markdown Make description of static keyword stronger, closes #2848 2018-10-09 23:10:17 +05:30
c++.html.markdown [en] Typo in c++ 2019-03-10 23:56:47 +02:00
chapel.html.markdown Note official chaple build doc 2018-07-23 18:04:27 -07:00
CHICKEN.html.markdown Fix #3058 2018-02-28 17:01:12 +05:45
citron.html.markdown [Citron/en] Add basic explanations 2018-07-14 19:17:46 +04:30
clojure-macros.html.markdown [clojure-macros] Fixed links (#3351) 2018-10-31 06:44:17 +05:30
clojure.html.markdown Changed a name in a code example to make it British English-friendly 2018-09-28 17:02:14 -07:00
cmake.html.markdown Move "cmake" articles to the "tool" category 2019-03-08 17:20:20 +01:00
coffeescript.html.markdown Move the description to the beginning with the other text 2016-12-14 15:53:36 -08:00
coldfusion.html.markdown Set syntax highlighting for coldfusion 2016-12-31 15:36:08 -08:00
common-lisp.html.markdown Fix default make-array value, closes #2578 2018-10-09 22:49:47 +05:30
compojure.html.markdown Use keywords in POST/PUT examples 2015-05-30 11:43:37 -06:00
CONTRIBUTING.markdown Add infos about the "category" header in CONTRIBUTING.md 2019-03-08 17:24:13 +01:00
crystal.html.markdown Add new Int128 and UInt128 types 2019-02-13 10:46:45 +00:00
csharp.html.markdown Add more c#7 features 2017-10-27 14:27:14 +08:00
css.html.markdown css: add selector groups 2018-05-07 12:47:20 +02:00
cypher.html.markdown Revert "Fix build error in 'build/docs/cypher/index.html'" 2018-08-29 18:03:27 +05:30
d.html.markdown fix language code suffix(#2832) 2017-08-25 14:25:11 +05:45
dart.html.markdown Fix var/class/func naming 2018-12-27 18:13:44 +05:30
dynamic-programming.html.markdown added more resources 2019-03-13 17:01:54 +05:30
edn.html.markdown Improve the "Tagged Elements" section of EDN doc 2017-10-21 20:33:14 -04:00
elisp.html.markdown t evaluates to t, so it doesn't need to be quoted 2019-03-18 21:17:45 +00:00
elixir.html.markdown Fix broken link 2018-12-27 19:40:21 -05:00
elm.html.markdown [elm] Update code to access tuples 2017-12-23 11:57:45 +01:00
erlang.html.markdown [erlang] Update guard sequences URL to use named id (#2613) 2016-12-29 01:41:35 +01:00
factor.html.markdown Factor highlight is here 2018-10-23 20:36:28 -07:00
file.erb Added filename parameter 2013-06-29 20:19:14 -07:00
forth.html.markdown Fix tuck definition 2017-10-16 14:32:51 +08:00
fortran95.html.markdown Fix a bunch of typos 2017-08-23 10:14:39 +02:00
fsharp.html.markdown [fsharp/en] Add note on equality operator 2018-09-20 13:48:58 +02:00
Gemfile Add rubygems.org as gem source so Travis CI can use charlock_holmes 2016-11-09 21:02:04 -08:00
Gemfile.lock adds Gemfile.lock (#2664) 2017-03-21 18:19:49 -07:00
git.html.markdown add Git resource 2018-10-20 21:11:17 +05:30
go.html.markdown Fix defer wording, closes #2673 2018-10-09 22:59:19 +05:30
groovy.html.markdown [groovy] small fix in iteration over a map 2017-10-04 16:15:38 +02:00
hack.html.markdown Fix a bunch of typos 2017-08-23 10:14:39 +02:00
haml.html.markdown [haml/en] Fix mistakes in English text 2017-09-28 09:00:33 +03:00
haskell.html.markdown Restore lost articles 2018-08-01 21:12:35 -07:00
haxe.html.markdown noticed a few more 2019-02-20 17:20:29 -05:00
hq9+.html.markdown 2431 2017-05-25 14:29:39 +02:00
hre.csv Add hre.csv to this repo directly 2018-10-15 23:22:14 -04:00
html.html.markdown Update html.html.markdown 2019-02-15 15:14:59 +05:30
hy.html.markdown Fix a bunch of typos 2017-08-23 10:14:39 +02:00
inform7.html.markdown Add a try at an Inform 7 tutorial. 2016-01-22 00:54:44 +00:00
ISSUE_TEMPLATE.md Update ISSUE_TEMPLATE.md 2018-06-02 17:46:37 +05:45
java.html.markdown [Java/en] Added Lambdas section. 2018-04-11 18:12:59 -04:00
javascript.html.markdown Fix js prototype example 2019-01-21 16:04:23 +03:00
jquery.html.markdown add jQuery resource 2018-10-20 21:30:06 +05:30
json.html.markdown Fixed typo. 2018-11-12 21:14:08 +02:00
julia.html.markdown Add note about integer overflow 2019-02-18 12:25:23 +11:00
kdb+.html.markdown Update kdb+.html.markdown 2018-07-06 09:23:09 -04:00
kotlin.html.markdown refactor operator overloading example; reorder code 2019-03-23 13:31:06 +00:00
lambda-calculus.html.markdown Update lambda-calculus.html.markdown 2019-03-17 13:36:27 -04:00
latex.html.markdown Fix hint 2019-01-24 21:23:32 +01:00
less.html.markdown missing right parenthesis (#2596) 2016-12-13 02:29:12 +01:00
lfe.html.markdown Update lfe.html.markdown 2017-08-18 10:12:58 -07:00
livescript.html.markdown removing whitespace all over 2015-10-07 23:11:24 -04:00
logtalk.html.markdown Improve section on compiling and loading source files 2019-02-03 17:23:31 +00:00
LOLCODE.html.markdown Update LOLCODE.html.markdown 2017-07-04 13:24:03 -07:00
lua.html.markdown Update from gist/tylerneylon 2018-11-25 01:02:50 -03:00
m.html.markdown [M (MUMPS)/en] One-liner 2019-02-13 11:06:16 +01:00
make.html.markdown Move "make" articles to the "tool" category 2019-03-08 17:21:53 +01:00
markdown.html.markdown Fix build error in 'build/docs/markdown/index.html' 2018-08-15 17:41:56 +05:30
matlab.html.markdown [en] Adjust statement 2018-08-31 12:13:02 +08:00
mercurial.html.markdown [mercurial/en] Multiple fixes (#3355) 2018-10-31 02:29:41 +05:30
messagepack.html.markdown Add messagepack as a tool 2016-10-21 15:36:15 -07:00
mips.html.markdown mips asm 2018-08-24 19:45:59 -07:00
montilang.html.markdown Update montilang.html.markdown 2018-09-08 23:46:28 +10:00
moonscript.html.markdown [moonscript/en] Created MoonScript markdown 2018-09-08 15:31:57 -04:00
neat.html.markdown removing whitespace all over 2015-10-07 23:11:24 -04:00
nim.html.markdown Fix the multiline Nim comment 2017-12-27 13:36:04 -05:00
nix.html.markdown [nix/en]: remove and update broken link 2018-03-01 21:45:50 +08:00
objective-c.html.markdown Add missing block referred to in comment 2018-03-25 17:46:45 -07:00
ocaml.html.markdown [ocaml/en] Fix typo 2019-01-09 17:10:06 -08:00
opencv.html.markdown Added new empty line 2018-10-14 12:40:30 +05:30
p5.html.markdown Include myself as a contributor 2019-03-26 13:17:08 +01:00
paren.html.markdown Updating header with contribution name 2015-10-20 11:40:45 -03:00
pascal.html.markdown Fixed missing escape character 2019-02-07 19:27:55 -05:00
pcre.html.markdown [pcre] Fix examples, closes #3226 2018-10-23 23:05:09 +02:00
perl6-pod.html.markdown Add some minor changes: 2019-01-01 18:07:52 -05:00
perl6.html.markdown Add some changes 2018-12-19 17:15:21 -05:00
perl.html.markdown [perl/en] Use more single quotes and explain single vs double quotes (#2710) 2017-05-18 12:40:15 +02:00
pets.csv Create pets.csv 2013-06-29 03:38:34 -04:00
php-composer.html.markdown [php-composer/en] Add new tool document for Composer, PHP's dependency manager. 2015-10-20 12:46:58 +13:00
php.html.markdown Fix exception handling example 2018-11-02 04:21:54 +05:30
pogo.html.markdown Fixed typo at the end 2014-12-22 13:26:30 +01:00
powershell.html.markdown Fix typo in powershell page 2019-02-02 20:41:28 -05:00
processing.html.markdown Add name to contributors 2018-11-17 20:55:33 +05:30
prolog.html.markdown [prolog/en] Corrected statement about unifying two free terms (#3033) 2018-02-28 17:26:09 +05:45
PULL_REQUEST_TEMPLATE.md Update PULL_REQUEST_TEMPLATE.md 2017-02-11 21:53:48 -08:00
purescript.html.markdown Fix purescript array of ints/numbers 2018-10-03 15:21:23 +02:00
pyqt.html.markdown try to fix (again) #2496 2016-10-23 14:24:50 +02:00
python3.html.markdown Update python3.html.markdown 2019-02-05 12:43:07 -07:00
python.html.markdown [python/py3] Updating set info (#3473) 2019-02-16 23:37:14 +05:30
pythonstatcomp.html.markdown Add import to resolve changes in new versions of python 2018-10-15 23:22:34 -04:00
qt.html.markdown Add language code suffix(#2832) 2017-08-25 14:03:17 +05:45
r.html.markdown Fix #3479 2019-02-28 18:40:00 +05:30
racket.html.markdown Fix section numbering 2018-12-03 22:30:37 +01:00
Rakefile Update rakefile so that it will return an exit code of 1 if there is a failure (Travis CI needs this). Make ISO-8859* encoding detections notices not failures 2016-11-09 22:15:03 -08:00
README.markdown Fix missing parenthesis 2016-11-09 22:31:46 -08:00
red.html.markdown Update red.html.markdown 2018-11-26 09:56:09 +01:00
rst.html.markdown Update rst.html.markdown 2019-04-15 15:46:38 -04:00
ruby-ecosystem.html.markdown Update ruby-ecosystem.html.markdown 2018-08-02 14:43:03 +01:00
ruby.html.markdown Update ruby.html.markdown 2018-10-16 16:58:55 +02:00
rust.html.markdown Add gescription related break statement 2018-09-20 13:04:31 +02:00
sass.html.markdown set highlighter for sass and red 2016-12-31 15:43:35 -08:00
scala.html.markdown Revert "[scala/en] Make return value example actually demonstrate issue" (#3213) 2018-09-08 23:29:35 +02:00
self.html.markdown [self-en] separeated -> separated 2016-02-22 20:27:17 -07:00
shutit.html.markdown Fix a bunch of typos 2017-08-23 10:14:39 +02:00
smallbasic.html.markdown [smallbasic/en] minor fact check fix (#2312) 2016-07-17 01:51:57 +02:00
smalltalk.html.markdown Fixing tabs/spaces as per feedback received & some other minor changes 2019-01-04 07:59:16 -08:00
solidity.html.markdown update chinese version content 2018-12-25 15:08:20 +08:00
sql.html.markdown Eschew backticks in sql 2018-11-04 09:52:15 -08:00
standard-ml.html.markdown Added a comment to better demonstrate custom datatypes. 2019-03-15 11:01:23 +02:00
stylus.html.markdown Fix empty lines 2019-01-10 17:07:51 +05:30
swift.html.markdown Removed deprecated reference 2018-10-11 14:21:54 -07:00
tcl.html.markdown update tcl/en hyperlinks 2018-10-22 20:59:56 -05:00
tcsh.html.markdown Move "tcsh" articles to the "tool" category 2019-03-08 17:22:26 +01:00
textile.html.markdown Update textile.html.markdown 2018-10-07 15:10:11 -07:00
tmux.html.markdown [tmux/en] adding info about copy mode 2018-10-28 11:55:41 -05:00
toml.html.markdown Fix build error in 'build/docs/toml/index.html' 2018-08-15 17:26:28 +05:30
typescript.html.markdown Fixes typo 2019-01-27 18:06:34 +03:00
vala.html.markdown Added profiles and D-Bus integration reading 2017-08-26 11:33:08 -04:00
vim.html.markdown DOC: vim.html.markdown: markdown listify lists 2018-12-21 15:48:10 -05:00
visualbasic.html.markdown Typo 2019-03-13 23:03:26 +03:00
vyper.html.markdown Create vyper.html.markdown 2019-03-20 01:16:40 -04:00
whip.html.markdown Add comment to separate functions categories 2017-10-23 16:31:26 -02: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 Removed duplicate **is** 2018-12-07 20:48:37 +05:30
zfs.html.markdown [zfs/en] Fix unordered lists markdown formatting 2017-09-27 23:36:23 -07:00

Learn X in Y minutes

Build Status

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 prepend the tag [language/lang-code] to your issues and pull requests. For example, [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.

For a detailed style guide, please review the full CONTRIBUTING guidelines.

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.