mirror of https://github.com/adambard/learnxinyminutes-docs.git synced 2024-12-23 09:41:36 +00:00

Code documentation written as code! How novel and totally my idea!

Go to file

Martin Schimandl c378f8da3d Add -de filename suffix, as requested.		2016-03-11 20:05:03 +01:00
cs-cz
de-de
el-gr
es-es
fa-ir
fr-fr
hu-hu
id-id
it-it
ja-jp
ko-kr
nl-nl
no-nb
pl-pl
pt-br
pt-pt
ro-ro
ru-ru
ta_in
tr-tr
vi-vn
zh-cn
amd.html.markdown
asymptotic-notation.html.markdown
bash.html.markdown
brainfuck.html.markdown
c.html.markdown
c++.html.markdown	[C++/en] Added in Enum information	2015-10-17 06:05:54 -04:00
chapel.html.markdown
clojure-macros.html.markdown
clojure.html.markdown	Copy arrow docs from french.	2015-10-18 00:31:19 +08:00
coffeescript.html.markdown
coldfusion.html.markdown
common-lisp.html.markdown
compojure.html.markdown
csharp.html.markdown	Fixed indentation in csharp file.	2015-10-17 19:50:09 -04:00
css.html.markdown	fix merge conflict in css.html.markdown	2015-10-13 10:06:11 -04:00
d.html.markdown
dart.html.markdown
elisp.html.markdown
elixir.html.markdown
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
fsharp.html.markdown	Typo: "easily" rather than "easy"	2015-10-08 09:00:59 -04:00
git.html.markdown
go.html.markdown
groovy.html.markdown
hack.html.markdown
haml.html.markdown
haskell.html.markdown	change haskell's operator `$` description wording	2015-07-06 10:40:05 +02:00
haxe.html.markdown
hy.html.markdown	Changed function name to match function call	2014-12-16 22:33:08 +05:30
java.html.markdown	Fix Spacing Inconsistency (Switch Statement)	2015-10-16 21:50:34 -04:00
javascript.html.markdown
json.html.markdown
julia.html.markdown
latex.html.markdown
livescript.html.markdown
lua.html.markdown
make.html.markdown
markdown.html.markdown
matlab.html.markdown	[matlab/en] Added simple class example to Matlab	2015-10-08 21:20:37 +02:00
neat.html.markdown
nim.html.markdown	Sugar Assert fix	2015-10-07 21:19:50 -04:00
objective-c.html.markdown
ocaml.html.markdown
paren.html.markdown
perl6.html.markdown
perl.html.markdown
pets.csv
php.html.markdown
pogo.html.markdown
purescript.html.markdown
python3.html.markdown	Added instructions for input operations in Python3	2015-10-14 21:16:18 +05:30
python.html.markdown
pythonstatcomp.markdown.html
r.html.markdown
racket.html.markdown
README.markdown
red.html.markdown
ruby-ecosystem.html.markdown
ruby.html.markdown
rust.html.markdown
sass.html.markdown
scala.html.markdown	Fix compile errors of the English and French Scala tutorials	2015-10-10 16:49:53 +01:00
self.html.markdown
smalltalk.html.markdown
standard-ml.html.markdown
swift.html.markdown	Merge pull request #1381 from cwalk/swift-2	2015-10-09 10:08:24 -05:00
tcl.html.markdown
tmux.html.markdown
typescript.html.markdown
visualbasic.html.markdown
whip.html.markdown
xml.html.markdown
yaml.html.markdown
zfs.html.markdown

README.markdown

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, 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.