contrapunctus
/
docspec
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Create README

This commit is contained in:
contrapunctus 2022-01-21 18:32:37 +05:30
commit 6d0a123ec7
1 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
README.org Normal file
View File

@ -0,0 +1,9 @@
#+TITLE: DocSpec
DocSpec provides a standard, predictable interface to access the [[https://diataxis.fr/][four different types of documentation]].
DocSpec is
1. a configuration file in your project root, specifying how to reach sections of your documentation, and associating symbols with them if desired
2. a Common Lisp library to query the file
3. a command line client built on the library
4. an Emacs package, providing a =completing-read= interface