Teach Markdown printer about @mapping and @command

diff --git a/lib/Docvim/Printer/Markdown.hs b/lib/Docvim/Printer/Markdown.hs
index 6e2aa97fa6b21e35bff034e220b23ae30a66a19b..c3f3d883ad65733e67f40dc16a55a04724ef1264 100644 (file)
--- a/lib/Docvim/Printer/Markdown.hs
+++ b/lib/Docvim/Printer/Markdown.hs
@@ -2,6 +2,7 @@ module Docvim.Printer.Markdown (markdown) where
 
 import Control.Monad.Reader
 import Data.List (intercalate, sort)
+import Data.Maybe (fromMaybe)
 import Docvim.AST
 import Docvim.Parse (rstrip)
 import Docvim.Visitor.Plugin (getPluginName)
@@ -30,6 +31,7 @@ node n = case n of
   -- TODO, for readability, this should be "<br />\n" (custom, context-aware separator; see Vim.hs)
   BreakTag                -> return "<br />"
   Code c                  -> return $ "`" ++ c ++ "`"
+  CommandAnnotation {}    -> return $ command n
   CommandsAnnotation      -> return "## Commands\n\n"
   DocBlock d              -> nodes d
   Fenced f                -> return $ fenced f ++ "\n\n"
@@ -40,6 +42,7 @@ node n = case n of
   LinkTargets l           -> return $ linkTargets l ++ "\n"
   List ls                 -> nodes ls >>= nl
   ListItem l              -> fmap ("- " ++) (nodes l) >>= nl
+  MappingAnnotation m     -> return $ mapping m
   MappingsAnnotation      -> return "## Mappings\n\n"
   -- TODO: handle OptionAnnotation
   OptionsAnnotation       -> return "## Options\n\n"
@@ -108,3 +111,12 @@ attributesString as = unwords (map attributeToString as)
 
 gitHubAnchor :: String -> String
 gitHubAnchor n = "#user-content-" ++ sanitizeAnchor n
+
+-- TODO: make sure symbol table knows about mapping targets and command targets
+-- and option targets
+command :: Node -> String
+command (CommandAnnotation name params) = (rstrip heading) ++ "`\n\n"
+  where heading = "### `:" ++ name ++ " " ++ fromMaybe "" params
+
+mapping :: String -> String
+mapping name = "### `" ++ name ++ "`\n\n"