gitmyhub

learnxinyminutes-docs

Markdown ★ 12k updated 14d ago

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

Learn X in Y Minutes is a community collection of fast-read guides for programming languages, each teaching syntax through heavily commented working code in a single short session.

Markdownsetup: easycomplexity 1/5

This repository is the source content for the Learn X in Y Minutes website, a collection of quick-start guides for programming languages and tools. Each guide teaches a language by walking through commented, working code, so you learn by reading actual syntax rather than prose explanations. The format is deliberately fast: the goal is to give you a usable overview of a language in a short sitting, not a complete course.

The content covers a range of programming languages, with the site describing itself as aiming to cover both popular ones and ones the authors think deserve more attention. Each document is a source code file with heavy inline comments, formatted so the comments carry the tutorial and the code itself demonstrates the concepts being described.

The project is entirely community-driven. Anyone can contribute by copying the formatting of an existing file, writing a new language guide, or translating an existing one into another spoken language. Contributions of any size are welcome, from fixing a typo to adding a new article from scratch. Pull requests and issues can be filed at any time, and the repository maintainers ask that issues include a tag indicating which language or translation they concern.

Contributors retain copyright over their own work. The content on each page is published under a Creative Commons Attribution-ShareAlike license, which allows reuse and adaptation as long as credit is given and derivative work is shared under the same terms. The website version of these documents is at learnxinyminutes.com.

Where it fits