showthedocs
Posted by jpluimers on 2021/02/18
is a documentation browser that finds the relevant docs for your code. It works by parsing the code and connecting parts of it to their explanation in the docs
, and supports these languages:
- SQL
- postgresql
- mysql
- Configuration
- nginx
- gitconfig
You can enter any language text, then click the language, followed by clicking the “SHOW ME THE DOCS!” button, for which an example is further below.
The site has an open architecture, allowing to plug in more languages and documentation:
- [WayBack] showthedocs – how to contribute, with examples on the current structure:
- [WayBack] add support for git config files · idank/showthedocs@14bcc72 · GitHub: Docs scraped off git-scm.com. Parser is built with pyparsing.
- [WayBack] showthedocs/ast.py at master · idank/showthedocs · GitHub
- [WayBack] showthedocs/common.py at master · idank/showthedocs · GitHub: Context
- [WayBack] showthedocs/common.py at master · idank/showthedocs · GitHub: lexer import
- [WayBack] showthedocs/nginx.py at master · idank/showthedocs · GitHub
- [WayBack] showthedocs/getdocs at master · idank/showthedocs · GitHub
- [WayBack] showthedocs – about
- [WayBack] GitHub – idank/showthedocs
gitconfig example
So for instance the below ./git/config file leads to this result [WayBack] where you can click on all the coloured areas for easy navigation through the documentation:
- on the “query”:
- on the “legend” and “index”:
[core] repositoryformatversion = 0 filemode = true bare = false logallrefupdates = true [remote "origin"] url = https://github.com/jpluimers/checkssl.git fetch = +refs/heads/*:refs/remotes/origin/* [branch "master"] remote = origin merge = refs/heads/master [branch "support--server_apache2"] remote = origin merge = refs/heads/support--server_apache2
–jeroen
The Wiert Corner - irregular stream of stuff 
Leave a comment