gov.nasa.earthdata/codox-theme

A Codox Theme for NASA EOSDIS Clojure Projects' Documentation


License
EPL-1.0

Documentation

NASA EOSDIS Codox Theme

This is a modern and responsive codox theme developed for use by NASA EOSDIS Clojure projects and based based on codox-theme-rdash.

Clojars Theme

Clojars Theme with Code

Note that this needs codox ≥ 0.10.0.

Usage

Add the following dependency to your project.clj:

Clojars Project

Then set the following:

:codox {:themes [:eosdis]}

For syntax highlighting capabilities, you'll need to activate Markdown rendering via:

:codox {:metadata {:doc/format :markdown}
        :themes [:eosdis]}

To add Tophat to the docs, update your :codox profile to incorporate the necessary HTML transforms. Here's a working example:

:codox {
	:project {
	  :name "CMR OPeNDAP"
	  :description "OPeNDAP/CMR Integration"}
	:namespaces [#"^cmr\.opendap\.(?!dev)"]
	:metadata {
	  :doc/format :markdown
	  :doc "Documentation forthcoming"}
	:themes [:eosdis]
	:html {
	  :transforms [[:head]
	               [:append
	                 [:script {
	                   :src "https://cdn.earthdata.nasa.gov/tophat2/tophat2.js"
	                   :id "earthdata-tophat-script"
	                   :data-show-fbm "true"
	                   :data-show-status "true"
	                   :data-status-api-url "https://status.earthdata.nasa.gov/api/v1/notifications"
	                   :data-status-polling-interval "10"}]]
	               [:body]
	               [:prepend
	                 [:div {:id "earthdata-tophat2"
	                        :style "height: 32px;"}]]
	               [:body]
	               [:append
	                 [:script {
	                   :src "https://fbm.earthdata.nasa.gov/for/CMR/feedback.js"
	                   :type "text/javascript"}]]]}
	:doc-paths ["resources/docs/markdown"]
	:output-path "resources/public/docs/opendap/docs/reference"}

License

Copyright © 2018 NASA

Copyright © 2017 Duncan McGreggor

Copyright © 2016 Yannick Scherer

This project is licensed under the Eclipse Public License 1.0.

Derivative

This theme is based on the codox default assets licensed under the Eclipse Public License v1.0:

Copyright (c) 2016 James Reeves

The RDash UI assets are licensed under the MIT license:

The MIT License (MIT)

Copyright (c) 2014 rdash

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.