Upgrade APIDOC version

llaske · Apr 21, 2024 · b32a7ab · b32a7ab
1 parent 799cca9
commit b32a7ab
Show file tree

Hide file tree

Showing 8 changed files with 572 additions and 239 deletions.
diff --git a/api/controller/journal.js b/api/controller/journal.js
@@ -1065,10 +1065,10 @@ exports.removeInJournal = function(req, res) {
  *
  * @apiSuccess {String} _id Unique id of the journal
  * @apiSuccess {Object} content Array containing data of the entries
- * @apiSuccess {Object} content[i].metadata Metadata of the entries, i.e. characteristics of the entry
- * @apiSuccess {String} content[i].objectId Unique id of the entry in the journal
- * @apiSuccess {String} content[i].objectId Unique id of the entry in the journal
- * @apiSuccess {String} content[i].text Text of the entries, i.e. storage value of the entry. It depends of the entry type
+ * @apiSuccess {Object} content.metadata Metadata of the entries, i.e. characteristics of the entry
+ * @apiSuccess {String} content.objectId Unique id of the entry in the journal
+ * @apiSuccess {String} content.objectId Unique id of the entry in the journal
+ * @apiSuccess {String} content.text Text of the entries, i.e. storage value of the entry. It depends of the entry type
  *
  * @apiSuccessExample {json} Success-Response:
  *     HTTP/1.1 200 OK

diff --git a/docs/www/assets/main.bundle.js b/docs/www/assets/main.bundle.js
diff --git a/docs/www/assets/main.css b/docs/www/assets/main.css
@@ -49,10 +49,16 @@ input[type="date"] {
   src: url('./glyphicons-halflings-regular.eot');
   src: url('./glyphicons-halflings-regular.eot?#iefix') format('embedded-opentype'),
     url('./glyphicons-halflings-regular.woff') format('woff'),
+    url('./glyphicons-halflings-regular.woff2') format('woff2'),
     url('./glyphicons-halflings-regular.ttf') format('truetype'),
     url('./glyphicons-halflings-regular.svg#glyphicons-halflingsregular') format('svg');
 }
 
+/* Hide vertical scrollbar on off canvas animation ("left" positioning) */
+html {
+  overflow-x: hidden;
+}
+
 body {
   font-family: "Source Sans Pro", sans-serif;
 }
@@ -63,7 +69,6 @@ a:focus {
 
 #content {
   margin-top: 10px;
-  margin-left: 20%;
   padding-left: 10px;
 }
 
@@ -193,16 +198,30 @@ td.code {
 /* ------------------------------------------------------------------------------------------
  * Sidenav
  * ------------------------------------------------------------------------------------------ */
+#scrollingNav {
+  position: fixed;
+  top: 0;
+  left: 0;
+  bottom: 0;
+  z-index: 10;
+  background-color: var(--dark-gray);
+  box-shadow: 0 2px 5px 0 rgb(0 0 0 / 16%), 0 2px 10px 0 rgb(0 0 0 / 12%);
+}
+
 .sidenav {
   color: var(--white);
-  width: 20%;
-  position: fixed;
+  position: absolute;
   top: 50px;
   left: 0;
+  right: 0;
   bottom: 0;
   overflow-x: hidden;
+  overflow-y: hidden;
+}
+
+.sidenav:hover {
+  overflow-x: auto;
   overflow-y: auto;
-  background-color: var(--dark-gray);
 }
 
 .sidenav > li > a {
@@ -250,14 +269,80 @@ td.code {
 }
 */
 
+/*
+ * Off Canvas
+ * --------------------------------------------------
+ */
+@media screen and (max-width: 767px) {
+  #content {
+    margin-top: 58px;
+  }
+
+  .row-offcanvas {
+    position: relative;
+    -webkit-transition: all .25s ease-out;
+    -o-transition: all .25s ease-out;
+    transition: all .25s ease-out;
+    left: 0;
+  }
+
+  .row-offcanvas,
+  .row-offcanvas * {
+    transition: all 0.5s ease-out;
+  }
+
+  .row-offcanvas .sidebar-offcanvas {
+    position: absolute;
+    top: 0;
+    left: -200px !important; /* 6 columns */
+    width: 100%; /* 6 columns */
+    max-width: 200px;
+  }
+
+  .nav-toggle {
+    position: fixed;
+    left: 0;
+    background: var(--dark-gray);
+    width: 100%;
+  }
+
+  .nav-toggle .btn {
+    margin: 10px 14px;
+  }
+  .nav-toggle .icon-bar {
+    display: block;
+    width: 22px;
+    height: 2px;
+    border-radius: 1px;
+    background-color: var(--white);
+  }
+  .nav-toggle .icon-bar + .icon-bar {
+    margin-top: 4px;
+  }
+
+  .row-offcanvas.active .sidebar-offcanvas {
+    left: 0 !important; /* 6 columns */
+  }
+  .row-offcanvas.active, .row-offcanvas.active .nav-toggle {
+    left: 200px;
+  }
+  /* Styling the three lines to make it an X */
+  .row-offcanvas.active .nav-toggle .btn > .icon-bar {
+    transform: rotate(45deg) translate(-4px, -4px);
+  }
+  .row-offcanvas.active .nav-toggle .btn .icon-bar:nth-child(2) {
+    display: none;
+  }
+  .row-offcanvas.active .nav-toggle .btn .icon-bar:nth-child(3) {
+    transform: rotate(-45deg);
+  }
+}
+
 /* ------------------------------------------------------------------------------------------
  * Side nav search
  * ------------------------------------------------------------------------------------------ */
 .sidenav-search {
-  width: 20%;
-  left: 0px;
-  position: fixed;
-  padding: 16px 20px 10px 20px;
+  padding: 16px 10px 10px;
   background-color: var(--dark-gray);
 }
 
@@ -273,10 +358,28 @@ td.code {
   height: 20px;
   text-align: center;
   right: 28px;
-  top: 17px;
+  top: 18px;
   background-color: #fff;
 }
 
+/* ------------------------------------------------------------------------------------------
+ * Prism - Toolbar
+ * ------------------------------------------------------------------------------------------ */
+div.code-toolbar.code-toolbar > .toolbar {
+  top: .4rem;
+  right: .4rem;
+}
+div.code-toolbar.code-toolbar > .toolbar > .toolbar-item > button:hover, 
+div.code-toolbar.code-toolbar > .toolbar > .toolbar-item > button:focus {
+  color: var(--white);
+}
+div.code-toolbar.code-toolbar > .toolbar > .toolbar-item > button {
+  color: var(--light-gray);
+  padding: .5em;
+  background: var(--hover-gray);
+  box-shadow: 0 2px 1px 1px rgba(0,0,0,.5);
+}
+
 /* ------------------------------------------------------------------------------------------
  * Compare
  * ------------------------------------------------------------------------------------------ */

diff --git a/docs/www/assets/prism-diff-highlight.css b/docs/www/assets/prism-diff-highlight.css
@@ -0,0 +1,13 @@
+pre.diff-highlight > code .token.deleted:not(.prefix),
+pre > code.diff-highlight .token.deleted:not(.prefix) {
+	background-color: rgba(255, 0, 0, .1);
+	color: inherit;
+	display: block;
+}
+
+pre.diff-highlight > code .token.inserted:not(.prefix),
+pre > code.diff-highlight .token.inserted:not(.prefix) {
+	background-color: rgba(0, 255, 128, .1);
+	color: inherit;
+	display: block;
+}
diff --git a/docs/www/assets/prism-toolbar.css b/docs/www/assets/prism-toolbar.css
@@ -0,0 +1,65 @@
+div.code-toolbar {
+	position: relative;
+}
+
+div.code-toolbar > .toolbar {
+	position: absolute;
+	z-index: 10;
+	top: .3em;
+	right: .2em;
+	transition: opacity 0.3s ease-in-out;
+	opacity: 0;
+}
+
+div.code-toolbar:hover > .toolbar {
+	opacity: 1;
+}
+
+/* Separate line b/c rules are thrown out if selector is invalid.
+   IE11 and old Edge versions don't support :focus-within. */
+div.code-toolbar:focus-within > .toolbar {
+	opacity: 1;
+}
+
+div.code-toolbar > .toolbar > .toolbar-item {
+	display: inline-block;
+}
+
+div.code-toolbar > .toolbar > .toolbar-item > a {
+	cursor: pointer;
+}
+
+div.code-toolbar > .toolbar > .toolbar-item > button {
+	background: none;
+	border: 0;
+	color: inherit;
+	font: inherit;
+	line-height: normal;
+	overflow: visible;
+	padding: 0;
+	-webkit-user-select: none; /* for button */
+	-moz-user-select: none;
+	-ms-user-select: none;
+}
+
+div.code-toolbar > .toolbar > .toolbar-item > a,
+div.code-toolbar > .toolbar > .toolbar-item > button,
+div.code-toolbar > .toolbar > .toolbar-item > span {
+	color: #bbb;
+	font-size: .8em;
+	padding: 0 .5em;
+	background: #f5f2f0;
+	background: rgba(224, 224, 224, 0.2);
+	box-shadow: 0 2px 0 0 rgba(0,0,0,0.2);
+	border-radius: .5em;
+}
+
+div.code-toolbar > .toolbar > .toolbar-item > a:hover,
+div.code-toolbar > .toolbar > .toolbar-item > a:focus,
+div.code-toolbar > .toolbar > .toolbar-item > button:hover,
+div.code-toolbar > .toolbar > .toolbar-item > button:focus,
+div.code-toolbar > .toolbar > .toolbar-item > span:hover,
+div.code-toolbar > .toolbar > .toolbar-item > span:focus {
+	color: inherit;
+	text-decoration: none;
+}