cljdoc.render.layout
Components to layout cljdoc pages
Components to layout cljdoc pages
artifact-descriptionclj
(artifact-description cache-id artifact-desc)Return a string to be used as description meta tag for a given project's documentation pages.
This description is same as the description in project's pom.xml file.
Return a string to be used as description meta tag for a given project's documentation pages. This description is same as the description in project's pom.xml file.
descriptionclj
(description cache-id)Return a string to be used as description meta tag for a given project's documentation pages.
Return a string to be used as description meta tag for a given project's documentation pages.
generic-descriptionclj
(generic-description {:keys [group-id artifact-id version] :as cache-id})Returns a generic description of a project.
Returns a generic description of a project.
mobile-nav-spacerclj
Spacer so fixed navigation elements don't overlap content
This is only needed on small screens so dn-ns hides it
on non-small screens
The height has been found by trial and error.
Spacer so fixed navigation elements don't overlap content This is only needed on small screens so `dn-ns` hides it on non-small screens The height has been found by trial and error.
no-js-warningclj
(no-js-warning)A small development utility component that will show a warning when the browser can't retrieve the application's JS sources.
A small development utility component that will show a warning when the browser can't retrieve the application's JS sources.
r-main-containerclj
Everything that's rendered on cljdoc goes into this container.
On desktop screens it fills the viewport forcing child nodes to scroll. On smaller screens it grows with the content allowing Safari to properly condense the URL bar when scrolling.
In contrast if the container was fixed on mobile as well Safari would perceive the scroll events as if the user scrolled in a smaller portion of the UI.
While height: 100vh would also work on desktop screens there are some
known issues around using viewport height units on mobile.
Everything that's rendered on cljdoc goes into this container. On desktop screens it fills the viewport forcing child nodes to scroll. On smaller screens it grows with the content allowing Safari to properly condense the URL bar when scrolling. In contrast if the container was fixed on mobile as well Safari would perceive the scroll events as if the user scrolled in a smaller portion of the UI. While `height: 100vh` would also work on desktop screens there are some known issues around [using viewport height units on mobile](https://nicolas-hoizey.com/2015/02/viewport-height-is-taller-than-the-visible-part-of-the-document-in-some-mobile-browsers.html).
r-top-bar-containerclj
Additional wrapping to make the top bar responsive
On small screens we render the top bar and mobile navigation as a
fixed div so that the main container can be scrolled without the
navigation being scrolled out of view.
On regular sized screens we use the default positioning setting of
static so that the top bar is rendered as a row of the main
container.
The z-index z-3 setting is necessary to ensure fixed elements
appear above other elements
Additional wrapping to make the top bar responsive On small screens we render the top bar and mobile navigation as a `fixed` div so that the main container can be scrolled without the navigation being scrolled out of view. On regular sized screens we use the default positioning setting of `static` so that the top bar is rendered as a row of the main container. The z-index `z-3` setting is necessary to ensure `fixed` elements appear above other elements
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close