From 23d82529b3703ed4d46fc1dd06f4d0e3e9ea2c09 Mon Sep 17 00:00:00 2001
From: mitchell <70453897+667e-11@users.noreply.github.com>
Date: Thu, 15 Mar 2012 13:13:24 -0400
Subject: Added documentation for generating API documentation and Lua
 Adeptsense.

---
 doc/11_Scripting.md | 27 +++++++++++++++++++++++----
 1 file changed, 23 insertions(+), 4 deletions(-)

(limited to 'doc/11_Scripting.md')

diff --git a/doc/11_Scripting.md b/doc/11_Scripting.md
index 86eb1a5a..d7275829 100644
--- a/doc/11_Scripting.md
+++ b/doc/11_Scripting.md
@@ -12,11 +12,30 @@ libraries. See the [`lua` module documentation][] for more information.
 
 ## LuaDoc and Examples
 
-Textadept's API is heavily documented. The [LuaDoc][] is the ultimate resource
-on scripting Textadept. There are of course abundant scripting examples since
-Textadept is mostly written in Lua.
+Textadept's API is heavily documented. The [API docs][] are the ultimate
+resource on scripting Textadept. There are of course abundant scripting examples
+since Textadept is mostly written in Lua.
 
-[LuaDoc]: api/index.html
+[API docs]: api/index.html
+
+### Generating LuaDoc
+
+You can generate API documentation for your own modules using the
+`doc/markdowndoc.lua` [LuaDoc][] module:
+
+    luadoc -d . --doclet _HOME/doc/markdowndoc [module(s)]
+
+or
+
+    luadoc -d . -t template_dir --doclet _HOME/doc/markdowndoc [module(s)]
+
+where `_HOME` is where Textadept is installed and `template_dir` is an optional
+template directory that contains two Markdown files: `.header.md` and
+`.footer.md`. (See `doc/.header.md` and `doc/.footer.md` for examples.) You must
+have [Discount][] installed.
+
+[LuaDoc]: http://keplerproject.github.com/luadoc/
+[Discount]: http://www.pell.portland.or.us/~orc/Code/discount/
 
 ## Lua Configuration
 
-- 
cgit v1.2.3