diff --git a/API.md b/API.md index 06e5932..9473942 100644 --- a/API.md +++ b/API.md @@ -11,8 +11,7 @@ API namespace for quickdoc. -## `quickdoc` [📃](https://github.com/borkdude/quickdoc/blob/main/src/quickdoc/api.cljc#L17-L80) - +## `quickdoc` ``` clojure (quickdoc opts) @@ -34,3 +33,4 @@ Generate API docs. Options: * `:filename-fn` - transformation of filename before it is rendered to markdown, e.g. for source links. Returns a map containing the generated markdown string under the key `:markdown`. +
source diff --git a/CHANGELOG.md b/CHANGELOG.md index efec535..e8244d4 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,6 +4,10 @@ Quick and minimal API doc generation for Clojure +## Unreleased + +- Revert source link in var title and move back to `` + ## v0.2.3 - Add `:filename-add-prefix` and `:filename-remove-prefix` options so quickdoc can more easily be configured from EDN diff --git a/src/quickdoc/impl.clj b/src/quickdoc/impl.clj index 9b4ad8f..d0196d3 100644 --- a/src/quickdoc/impl.clj +++ b/src/quickdoc/impl.clj @@ -98,7 +98,9 @@ ns-name (:name var) (:name var))) - (println (format " [📃](%s)" + ;; I found the icon too big and drawing too much attention, so I reverted to + ;; printing the source link in a below again + #_(println (format " [📃](%s)" (var-source var opts))) (println (format "" ns-name @@ -126,8 +128,9 @@ (println) (when (:macro var) (println "Macro.\n\n")) - (print-docstring ns->vars ns-name doc opts) - (when collapse-vars (println "\n\n"))))) + (print-docstring ns->vars ns-name doc opts)) + (println (format "
source" (var-source var opts))) + (when collapse-vars (println "\n\n")))) (defn print-namespace [ns-defs ns->vars ns-name vars opts overrides] (let [ns (get-in ns-defs [ns-name 0])