codox icon indicating copy to clipboard operation
codox copied to clipboard

A strategy for handling common markdown

Open jhalterman opened this issue 9 years ago • 0 comments

When writing markdown docs for a set of functions, it's common to require the same links over and over. Markdown supports reference style links which allow named links to be defined once and referenced numerous times in a document. It would be great if codox has some mechanism to support this - where a common markdown section/file, presumably to be used for defining reference links, could be specified once and then included in the markdown processing for a namespace or project. This would allow reference links to be available to use in the markdown on any function. Ex:

Common markdown file/section:

[Transport]: http://atomix.io/catalyst/api/latest/io/atomix/catalyst/transport/Transport.html

Some function defs:

(defn connect-transport 
  "Connects to the [Transport]"
  [transport] (connect transport))

(defn disconnect-transport 
  "Connects from the [Transport]"
  [transport] (disconnect transport))

jhalterman avatar Nov 05 '15 20:11 jhalterman