63b712e247
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.
|
||
|---|---|---|
| .. | ||
| aliases | ||
| common | ||
| images | ||
| 00-authors.md | ||
| 01-readme.md | ||
| 02-contributing.md | ||
| 03-declarative-layout.md | ||
| 04-new-widgets.md | ||
| 05-awesomerc.md.lua | ||
| 06-appearance.md.lua | ||
| 16-using-cairo.md | ||
| 90-FAQ.md | ||
| config.ld | ||
| doing_a_release.md | ||
| load_ldoc.cmake | ||
| widget_lists.cmake | ||