Mislav Marohnić
da562ad74c
replace build system with generated table of contents
Gets rid of `doc/README.mdtoc` and its build script. Since GitHub.com
renders anchors for each heading, all we have to do is put a simple
table of contents into `README.md` itself, and everything will get
linked up nicely.
Pros of this approach:
* We don't have to point out to people not to edit `README.md` anymore
* We don't have to run the build script each time README gets edited
Cons of this change:
* The "chapter" numbers are lost. They were silly anyway.
`doc/mdtoc` renders a Markdown table of contents for a Markdown file.
`doc/filter-toc` filters that down to only headings after ToC.
This script can be used to easily insert ToC into the current document
when editing `README.md` with, e.g., Vim:
:read !doc/filter-toc %
pirms 13 gadiem
Javier Candeira
7f1aefa09b
fix install instructions for ubuntu (using version 12.04, but should work for all versions)
pirms 13 gadiem
Guillermo Iguaran
2df165c49e
Sync doc/README.mdtoc with the actual README
All the changes to documentation should be done in doc/README.mdtoc
pirms 13 gadiem
Patrik Ragnarsson
406c8e0303
Fixed broken link to RVM in documentation
pirms 14 gadiem
Daryl Manning
5e57ab95ce
Changed doc/README.mdtoc and built README.md and changed nomenclature to 'ruby versions' as requested.
pirms 14 gadiem
Jussi Virtanen
34813ef32c
Fix typos in documentation
pirms 14 gadiem
Sam Stephenson
b10bdb1e78
rbenv 0.3.0
pirms 14 gadiem
Sam Stephenson
5052a4161c
Update readme screenshot to use `global` instead of `set-default` ( fixes #165 )
pirms 14 gadiem
Sam Stephenson
4cc6665d0a
Zsh users need to modify ~/.zshenv, not ~/.zshrc
pirms 14 gadiem
Sam Stephenson
01a0ad0b69
rbenv 0.2.1
pirms 15 gadiem
Sam Stephenson
2bbe2099eb
Missing word
pirms 15 gadiem
Sam Stephenson
fb0ec9e157
Be explicit about ~
pirms 15 gadiem
Sam Stephenson
7a929b8a84
Indentation
pirms 15 gadiem
Sam Stephenson
2cd12e3fa6
rbenv 0.2.0
pirms 15 gadiem
Sam Stephenson
4965a1d1f7
Style
pirms 15 gadiem
Sam Stephenson
dc1f583903
"Zsh" is the canonical capitalization
pirms 15 gadiem
Sam Stephenson
500c6de37c
fill-region
pirms 15 gadiem
Joshua Peek
88e59647ae
Installation edits
pirms 15 gadiem
Sam Stephenson
53d45707ca
Add Homebrew to the readme
pirms 15 gadiem
Sam Stephenson
828051e651
Move intro line above the fold
pirms 15 gadiem
Sam Stephenson
4712db8edd
Add version history
pirms 15 gadiem
Sam Stephenson
26a08c6d12
Add upgrade instructions
pirms 15 gadiem
Sam Stephenson
09d912895f
Fix markdown indentation
pirms 15 gadiem
Sam Stephenson
ada26ab92e
Document `rbenv which` and `rbenv whence`
pirms 15 gadiem
Sam Stephenson
a3d3005859
Document `rbenv shell`
pirms 15 gadiem
Sam Stephenson
aade3ad781
Sync mdtoc source
pirms 15 gadiem
Sam Stephenson
e43a2039a5
Sync mdtoc source
pirms 15 gadiem
Sam Stephenson
dfe9889327
Fix ruby-build link
pirms 15 gadiem
Sam Stephenson
192dc23998
Try a different image url
pirms 15 gadiem
Sam Stephenson
6c468d6166
Don't highlight the anchors
pirms 15 gadiem
Sam Stephenson
bfa71017ae
Add TOC header
pirms 15 gadiem
Sam Stephenson
066d63c0df
Use mdtoc for the readme
pirms 15 gadiem