Skip to content

justinjhendrick/learnxinyminutes-docs

This branch is 5 commits ahead of, 7983 commits behind adambard/learnxinyminutes-docs:master.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

4e6396a · Jul 8, 2014
Jun 1, 2014
May 19, 2014
Jan 30, 2014
Jun 14, 2014
Mar 7, 2014
Mar 14, 2014
Mar 11, 2014
Jun 1, 2014
Jun 5, 2014
Dec 4, 2013
May 7, 2014
May 6, 2014
Sep 20, 2013
Oct 28, 2013
Jun 14, 2014
Sep 5, 2013
Feb 28, 2014
Sep 20, 2013
Jun 28, 2014
Jan 20, 2014
Oct 28, 2013
May 12, 2014
Apr 3, 2014
May 26, 2014
May 1, 2014
Jul 4, 2013
Apr 29, 2014
Jun 7, 2014
May 19, 2014
Jun 30, 2013
Jul 4, 2013
Jun 3, 2014
Jul 2, 2014
Sep 2, 2013
Feb 3, 2014
Feb 15, 2014
Jan 11, 2014
Feb 13, 2014
Jun 10, 2014
Jun 19, 2014
Jun 5, 2014
Apr 14, 2014
Mar 3, 2014
Jun 11, 2014
Apr 7, 2014
Sep 9, 2013
Mar 19, 2014
Jul 8, 2014
May 26, 2014
Jun 10, 2014
Jun 29, 2013
Jan 17, 2014
Sep 20, 2013
May 1, 2014
Jun 16, 2014
May 29, 2014
Mar 20, 2014
Feb 7, 2014
Sep 8, 2013
Mar 10, 2014
Jul 1, 2014
Feb 28, 2014
Dec 16, 2013
Jun 5, 2014
Aug 1, 2013
Jun 21, 2014
May 31, 2014
Jun 1, 2014

Repository files navigation

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

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.

About

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

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published