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.

Name		Name	Last commit message	Last commit date
Latest commit History 3,170 Commits
cs-cz		cs-cz
de-de		de-de
el-gr		el-gr
es-es		es-es
fa-ir		fa-ir
fr-fr		fr-fr
hu-hu		hu-hu
id-id		id-id
it-it		it-it
ja-jp		ja-jp
ko-kr		ko-kr
nl-nl		nl-nl
no-nb		no-nb
pl-pl		pl-pl
pt-br		pt-br
pt-pt		pt-pt
ro-ro		ro-ro
ru-ru		ru-ru
tr-tr		tr-tr
vi-vn		vi-vn
zh-cn		zh-cn
README.markdown		README.markdown
amd.html.markdown		amd.html.markdown
asymptotic-notation.html.markdown		asymptotic-notation.html.markdown
bash.html.markdown		bash.html.markdown
brainfuck.html.markdown		brainfuck.html.markdown
c++.html.markdown		c++.html.markdown
c.html.markdown		c.html.markdown
chapel.html.markdown		chapel.html.markdown
clojure-macros.html.markdown		clojure-macros.html.markdown
clojure.html.markdown		clojure.html.markdown
coffeescript.html.markdown		coffeescript.html.markdown
common-lisp.html.markdown		common-lisp.html.markdown
compojure.html.markdown		compojure.html.markdown
csharp.html.markdown		csharp.html.markdown
css.html.markdown		css.html.markdown
d.html.markdown		d.html.markdown
dart.html.markdown		dart.html.markdown
elisp.html.markdown		elisp.html.markdown
elixir.html.markdown		elixir.html.markdown
erlang.html.markdown		erlang.html.markdown
file.erb		file.erb
forth.html.markdown		forth.html.markdown
fsharp.html.markdown		fsharp.html.markdown
git.html.markdown		git.html.markdown
go.html.markdown		go.html.markdown
groovy.html.markdown		groovy.html.markdown
hack.html.markdown		hack.html.markdown
haml.html.markdown		haml.html.markdown
haskell.html.markdown		haskell.html.markdown
haxe.html.markdown		haxe.html.markdown
hy.html.markdown		hy.html.markdown
java.html.markdown		java.html.markdown
javascript.html.markdown		javascript.html.markdown
json.html.markdown		json.html.markdown
julia.html.markdown		julia.html.markdown
livescript.html.markdown		livescript.html.markdown
lua.html.markdown		lua.html.markdown
make.html.markdown		make.html.markdown
markdown.html.markdown		markdown.html.markdown
matlab.html.markdown		matlab.html.markdown
neat.html.markdown		neat.html.markdown
nim.html.markdown		nim.html.markdown
objective-c.html.markdown		objective-c.html.markdown
ocaml.html.markdown		ocaml.html.markdown
paren.html.markdown		paren.html.markdown
perl.html.markdown		perl.html.markdown
perl6.html.markdown		perl6.html.markdown
pets.csv		pets.csv
php.html.markdown		php.html.markdown
pogo.html.markdown		pogo.html.markdown
purescript.html.markdown		purescript.html.markdown
python.html.markdown		python.html.markdown
python3.html.markdown		python3.html.markdown
r.html.markdown		r.html.markdown
racket.html.markdown		racket.html.markdown
red.html.markdown		red.html.markdown
ruby-ecosystem.html.markdown		ruby-ecosystem.html.markdown
ruby.html.markdown		ruby.html.markdown
rust.html.markdown		rust.html.markdown
scala.html.markdown		scala.html.markdown
self.html.markdown		self.html.markdown
standard-ml.html.markdown		standard-ml.html.markdown
swift.html.markdown		swift.html.markdown
tcl.html.markdown		tcl.html.markdown
tmux.html.markdown		tmux.html.markdown
typescript.html.markdown		typescript.html.markdown
visualbasic.html.markdown		visualbasic.html.markdown
whip.html.markdown		whip.html.markdown
xml.html.markdown		xml.html.markdown
yaml.html.markdown		yaml.html.markdown

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Repository files navigation

Learn X in Y minutes

We need YOU!...

Contributing

Style Guidelines

Header configuration

License

About

Releases

Packages

Languages

edglazer/learnxinyminutes-docs

Folders and files

Latest commit

History

Repository files navigation

Learn X in Y minutes

We need YOU!...

Contributing

Style Guidelines

Header configuration

License

About

Resources

Stars

Watchers

Forks

Releases

Packages 0

Languages

Packages