Commit Graph

5 Commits

Author SHA1 Message Date
Emmanuel Lepage Vallee 2fe4e68355 doc: Add keybinding documentation 2016-12-21 11:41:29 -05:00
Enric Morales 530e64e9ec Fix more typos 2016-12-16 22:02:35 +01:00
Enric Morales 2338f84369 Should be non-exhaustive instead of non-extensive 2016-12-14 15:53:13 +01:00
Enric Morales d7a0486da9 `awesomerc.md.lua` typos and grammar 2016-12-14 15:37:34 +01:00
Emmanuel Lepage Vallee 63b712e247 doc: Document rc.lua
This meta-lua script takes the "raw" awesomerc.lua and turn it
into the final file and generate a documentation page from its
parsed content. It support

 * Turn {{{ into markdown categories
 * Turn top level comments into documentation
 * Add custom documentation sections
 * Parse the code to add links for each API calls

This helps generate a good entry point for new users wanting to
understand the content of rc.lua without searching the API by
hand.

Over time, this will also become the basis of the documentation.

If `rc.lua` is separated into several files, this will be easy to fix
this script. It could even do the separation itself from a monolitic
file using the already implemented {{{ parser.
2016-09-26 00:40:20 -04:00