Skip to content

Commit

Permalink
Update codox.
Browse files Browse the repository at this point in the history
  • Loading branch information
@phronmophobic
phronmophobic committed Feb 18, 2024
1 parent 9cf14b7 commit b6b957b
Show file tree
Hide file tree
Showing 25 changed files with 656 additions and 549 deletions.
53 changes: 37 additions & 16 deletions deps.edn
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,22 +21,43 @@
slipset/deps-deploy {:mvn/version "RELEASE"}}
:ns-default build}

:codox {:extra-deps {codox/codox {:mvn/version "0.10.8"}}
:exec-fn codox.main/generate-docs
:exec-args {:source-paths ["src" "target/classes" "resources"]
:namespaces [
membrane.basic-components
membrane.cljfx
membrane.component
membrane.fulcro
membrane.java2d
membrane.lanterna
membrane.re-frame
membrane.skia
membrane.skija
membrane.toolkit
membrane.ui
]}}
:codox {:extra-deps {com.cnuernber/codox {:mvn/version "1.001"}
codox-theme-rdash/codox-theme-rdash {:mvn/version "0.1.2"}
com.googlecode.lanterna/lanterna {:mvn/version "3.1.1"}
org.jetbrains.skija/skija-macos-arm64 {:mvn/version "0.93.4"}
org.jetbrains.skija/skija-macos-x64 {:mvn/version "0.93.4"}
org.jetbrains.skija/skija-linux {:mvn/version "0.93.1"}
org.lwjgl/lwjgl {:mvn/version "3.3.0"}
org.lwjgl/lwjgl$natives-macos {:mvn/version "3.3.0"}
org.lwjgl/lwjgl$natives-macos-arm64 {:mvn/version "3.3.0"}
org.lwjgl/lwjgl$natives-linux {:mvn/version "3.3.0"}
org.lwjgl/lwjgl-glfw {:mvn/version "3.3.0"}
org.lwjgl/lwjgl-glfw$natives-macos {:mvn/version "3.3.0"}
org.lwjgl/lwjgl-glfw$natives-macos-arm64 {:mvn/version "3.3.0"}
org.lwjgl/lwjgl-glfw$natives-linux {:mvn/version "3.3.0"}
org.lwjgl/lwjgl-opengl {:mvn/version "3.3.0"}
org.lwjgl/lwjgl-opengl$natives-macos {:mvn/version "3.3.0"}
org.lwjgl/lwjgl-opengl$natives-macos-arm64 {:mvn/version "3.3.0"}
org.lwjgl/lwjgl-opengl$natives-linux {:mvn/version "3.3.0"}}
:exec-fn codox.main/-main
:exec-args
{:name "membrane"
:description "A Simple UI Library That Runs Anywhere"
:metadata {:doc/format :markdown}
:themes [:rdash]
:source-paths ["src"]
:output-path "docs/api"
:source-uri "https://github.com/phronmophobic/membrane/blob/main/{filepath}#L{line}"
:namespaces [
membrane.basic-components
membrane.component
membrane.java2d
membrane.lanterna
membrane.skia
membrane.skija
membrane.toolkit
membrane.ui
]}}

:skialib
{:extra-deps {com.phronemophobic.membrane/skialib-macosx-x86-64 {:mvn/version "RELEASE"
Expand Down
172 changes: 135 additions & 37 deletions docs/api/css/default.css
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,18 @@
@import url('https://fonts.googleapis.com/css?family=PT+Sans');

body {
font-family: Helvetica, Arial, sans-serif;
font-size: 15px;
font-family: 'PT Sans', Helvetica, sans-serif;
font-size: 14px;
}

a {
color: #337ab7;
text-decoration: none;
}

a:hover {
color: #30426a;
text-decoration: underline;
}

pre, code {
Expand All @@ -21,12 +33,8 @@ h2 {
font-size: 25px;
}

h5.license {
margin: 9px 0 22px 0;
color: #555;
font-weight: normal;
font-size: 12px;
font-style: italic;
h3 > a:hover {
text-decoration: none;
}

.document h1, .namespace-index h1 {
Expand Down Expand Up @@ -65,17 +73,20 @@ h5.license {
}

.sidebar.primary {
background: #e2e2e2;
background: #30426a;
border-right: solid 1px #cccccc;
left: 0;
width: 250px;
color: white;
font-size: 110%;
}

.sidebar.secondary {
background: #f2f2f2;
border-right: solid 1px #d7d7d7;
left: 251px;
width: 200px;
font-size: 110%;
}

#content.namespace-index, #content.document {
Expand All @@ -91,7 +102,7 @@ h5.license {
}

#header {
background: #3f3f3f;
background: #2d3e63;
box-shadow: 0 0 8px rgba(0, 0, 0, 0.4);
z-index: 100;
}
Expand Down Expand Up @@ -121,8 +132,20 @@ h5.license {
color: #f5f5f5;
}

.sidebar a {
color: #333;
.sidebar.primary, .sidebar.primary a {
color: #b2bfdc;
}

.sidebar.primary a:hover {
color: white;
}

.sidebar.secondary, .sidebar.secondary a {
color: #738bc0;
}

.sidebar.secondary a:hover {
color: #2d3e63;
}

#header h2 {
Expand All @@ -145,12 +168,16 @@ h5.license {
font-weight: lighter;
}

.sidebar h3 a {
color: #444;
.sidebar.primary h3.no-link {
text-transform: uppercase;
font-size: 12px;
color: #738bc0;
}

.sidebar h3.no-link {
color: #636363;
.sidebar.secondary h3 a {
text-transform: uppercase;
font-size: 12px;
color: #2d3e63;
}

.sidebar ul {
Expand All @@ -173,12 +200,6 @@ h5.license {
white-space: nowrap;
}

.sidebar li .no-link {
display: block;
color: #777;
font-style: italic;
}

.sidebar li .inner {
display: inline-block;
padding-top: 7px;
Expand Down Expand Up @@ -231,12 +252,12 @@ h5.license {
}

.sidebar.primary li.current a {
border-left: 3px solid #a33;
color: #a33;
border-left: 3px solid #e99d1a;
color: white;
}

.sidebar.secondary li.current a {
border-left: 3px solid #33a;
border-left: 3px solid #2d3e63;
color: #33a;
}

Expand All @@ -248,6 +269,11 @@ h5.license {
font-size: 16px;
font-weight: bold;
margin-bottom: 0;
letter-spacing: 0.05em;
border-bottom: solid 1px #ddd;
max-width: 680px;
background-color: #fafafa;
padding: 0.5em;
}

.namespace-index .topics {
Expand Down Expand Up @@ -376,7 +402,7 @@ h4.deprecated {
padding: 0;
font-size: 80%;
margin: 15px 0;
line-height: 16px;
line-height: 1.6em;
}

.index * {
Expand Down Expand Up @@ -432,6 +458,10 @@ p {
margin: 0;
}

.namespace-index {
font-size: 120%;
}

.namespace-index .doc {
margin-bottom: 20px;
}
Expand All @@ -441,28 +471,20 @@ p {
}

.markdown p, .markdown li, .markdown dt, .markdown dd, .markdown td {
line-height: 22px;
}

.markdown li {
padding: 2px 0;
line-height: 1.6em;
}

.markdown h2 {
font-weight: normal;
font-size: 25px;
margin: 30px 0 10px 0;
}

.markdown h3 {
font-weight: normal;
#content .markdown h3 {
font-size: 20px;
margin: 30px 0 0 0;
}

.markdown h4 {
font-size: 15px;
margin: 22px 0 -4px 0;
}

.doc, .public, .namespace .index {
Expand All @@ -480,10 +502,18 @@ p {
border-radius: 2px;
}

.markdown code:not(.hljs), .src-link a {
.src-link a {
background: #f6f6f6;
}

.markdown code:not(.hljs) {
color: #c7254e;
background-color: #f9f2f4;
border-radius: 4px;
font-size: 90%;
padding: 2px 4px;
}

pre.deps {
display: inline-block;
margin: 0 10px;
Expand Down Expand Up @@ -548,4 +578,72 @@ pre.deps {
padding: 1px 4px;
text-decoration: none;
color: #5555bb;
background-color: #f6f6f6;
}

blockquote {
opacity: 0.6;
border-left: solid 2px #ddd;
margin-left: 0;
padding-left: 1em;
}

/* Responsiveness Theme */

@media (max-device-width: 480px) {
.sidebar {
display:none;
}

#content {
position: relative;
left: initial !important;
top: 110px;
padding: 0 1em;
}

#header {
display: flex;
flex-direction: column-reverse;
height: 100px;
}

#header > h1 {
font-size: 52px;
}

#header h2 {
float: none;
font-size: 20px;
}

.namespace-index > h1 {
display: none;
}

.public, .doc, .namespace > .index, .namespace > .doc, .namespace > h3 {
max-width: initial;
}

.doc {
text-align: justify;
}

.public {
padding-top: 2em;
padding-bottom: 2em;
}

.public > h3 {
font-size: 300%;
}

.public > h4.type, .public > h4.added, .public > h4.deprecated {
font-size: 150%;
margin-top: 1em;
}

pre > code {
font-size: 200%;
}
}
Loading

0 comments on commit b6b957b

Please sign in to comment.