Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add support for advanced
:base-language
option
Author: @ptaoussanis This is an advanced option to help prevent any broken doc links when upgrading a project's docs from single language to dual language. In this case, :base-language can be set to the previous (single) language for which doc links may already exist in the wild. In detail, if cross-platform project then: {:base-language nil} => ".clj", ".cljs" file extensions ; Default {:base-language :clojure} => nil, ".cljs" file extensions {:base-language :clojurescript} => ".clj", nil file extensions For example: Library Foo previously used {:language :clojure} (either because it was Clojure only, or because of limitations in Codox). Various links to Foo's Codox documentation now exist in the wild. Foo's authors want to change to cross-platform, but don't want to break pre-existing links in the wild. In this case, Foo's authors can use the following opts: {:language #{:clojure :clojurescript} :base-language :clojure} This will produce files like the following: com.foolib.html ; For Clojure platform com.foolib.cljs.html ; For ClojureScript platform Any pre-existing links will successfully point to the same (Clojure) docs they did previously.
- Loading branch information