render documentation (#404)

docs/ReadMe.html

@@ -13,7 +13,7 @@
 
 <title>ReadMe</title>
 
-<script src="site_libs/header-attrs-2.11/header-attrs.js"></script>
+<script src="site_libs/header-attrs-2.25/header-attrs.js"></script>
 <script src="site_libs/jquery-3.6.0/jquery-3.6.0.min.js"></script>
 <meta name="viewport" content="width=device-width, initial-scale=1" />
 <link href="site_libs/bootstrap-3.3.5/css/cosmo.min.css" rel="stylesheet" />
@@ -29,7 +29,7 @@
        h6 {font-size: 12px;}
        code {color: inherit; background-color: rgba(0, 0, 0, 0.04);}
        pre:not([class]) { background-color: white }</style>
-<script src="site_libs/jqueryui-1.11.4/jquery-ui.min.js"></script>
+<script src="site_libs/jqueryui-1.13.2/jquery-ui.min.js"></script>
 <link href="site_libs/tocify-1.9.1/jquery.tocify.css" rel="stylesheet" />
 <script src="site_libs/tocify-1.9.1/jquery.tocify.js"></script>
 <script src="site_libs/navigation-1.1/tabsets.js"></script>
@@ -61,6 +61,7 @@
 
 
 
+
 <link rel="stylesheet" href="style.css" type="text/css" />
 
 
@@ -86,6 +87,9 @@
 summary {
   display: list-item;
 }
+details > summary > p:only-child {
+  display: inline;
+}
 pre code {
   padding: 0;
 }
@@ -142,11 +146,15 @@
     href = "index.html";
   var menuAnchor = $('a[href="' + href + '"]');
 
-  // mark it active
-  menuAnchor.tab('show');
-
-  // if it's got a parent navbar menu mark it active as well
-  menuAnchor.closest('li.dropdown').addClass('active');
+  // mark the anchor link active (and if it's in a dropdown, also mark that active)
+  var dropdown = menuAnchor.closest('li.dropdown');
+  if (window.bootstrap) { // Bootstrap 4+
+    menuAnchor.addClass('active');
+    dropdown.find('> .dropdown-toggle').addClass('active');
+  } else { // Bootstrap 3
+    menuAnchor.parent().addClass('active');
+    dropdown.addClass('active');
+  }
 
   // Navbar adjustments
   var navHeight = $(".navbar").first().height() + 15;
@@ -175,25 +183,18 @@
   border-radius: 4px;
 }
 
-.tabset-dropdown > .nav-tabs > li.active:before {
-  content: "";
+.tabset-dropdown > .nav-tabs > li.active:before, .tabset-dropdown > .nav-tabs.nav-tabs-open:before {
+  content: "\e259";
   font-family: 'Glyphicons Halflings';
   display: inline-block;
   padding: 10px;
   border-right: 1px solid #ddd;
 }
 
 .tabset-dropdown > .nav-tabs.nav-tabs-open > li.active:before {
-  content: "&#xe258;";
-  border: none;
-}
-
-.tabset-dropdown > .nav-tabs.nav-tabs-open:before {
-  content: "";
+  content: "\e258";
   font-family: 'Glyphicons Halflings';
-  display: inline-block;
-  padding: 10px;
-  border-right: 1px solid #ddd;
+  border: none;
 }
 
 .tabset-dropdown > .nav-tabs > li.active {
@@ -310,7 +311,7 @@
 <div class="navbar navbar-default  navbar-fixed-top" role="navigation">
   <div class="container">
     <div class="navbar-header">
-      <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar">
+      <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-bs-toggle="collapse" data-target="#navbar" data-bs-target="#navbar">
         <span class="icon-bar"></span>
         <span class="icon-bar"></span>
         <span class="icon-bar"></span>
@@ -376,14 +377,24 @@
 
 <div id="white-rabbit-documentation-readme" class="section level1">
 <h1>White Rabbit Documentation Readme</h1>
-<p>This folder contains the raw and rendered documentation of WhiteRabbit.</p>
+<p>This folder contains the raw (<code>.md</code>) and rendered
+(<code>.html</code>) documentation of WhiteRabbit. The documentation is
+renderd with the R package <code>rmarkdown</code> and used for the <a
+href="https://ohdsi.github.io/WhiteRabbit/">github.io page</a>.</p>
 <div id="contribute" class="section level2">
 <h2>Contribute</h2>
-<p>Contributions to the documentation are very welcome and even a must when new features are implemented. To update the documentation, edit one of the following markdown files or create a new markdown file: - <a href="/docs/WhiteRabbit.md">WhiteRabbit.md</a> - <a href="/docs/RabbitInAHat.md">RabbitInAHat.md</a> - <a href="/docs/riah_test_framework.md">riah_test_framework.md</a> - <a href="/docs/best_practices.md">best_practices.md</a></p>
+<p>Contributions to the documentation are very welcome and even a must
+when new features are implemented. To update the documentation, edit one
+of the following markdown files or create a new markdown file: - <a
+href="/docs/WhiteRabbit.md">WhiteRabbit.md</a> - <a
+href="/docs/RabbitInAHat.md">RabbitInAHat.md</a> - <a
+href="/docs/riah_test_framework.md">riah_test_framework.md</a> - <a
+href="/docs/best_practices.md">best_practices.md</a></p>
 </div>
 <div id="render-html" class="section level2">
 <h2>Render html</h2>
-<p>To generate the site from markdown files, run the following R script with the <code>./docs</code> folder as working directory. Run this in a standalone R session, this is orders of magnitude faster compared to running in RStudio.</p>
+<p>To generate the site from markdown files, run the following R code
+with the <code>./docs</code> folder as working directory.</p>
 <pre class="r"><code>#devtools::install_github(&quot;ropenscilabs/icon&quot;)
 library(rmarkdown)
 rmarkdown::render_site()</code></pre>

docs/ReadMe.md

@@ -2,7 +2,8 @@
 pagetitle: "ReadMe"
 ---
 # White Rabbit Documentation Readme
-This folder contains the raw and rendered documentation of WhiteRabbit.
+This folder contains the raw (`.md`) and rendered (`.html`) documentation of WhiteRabbit.
+The documentation is renderd with the R package `rmarkdown` and used for the [github.io page](https://ohdsi.github.io/WhiteRabbit/).
 
 ## Contribute
 Contributions to the documentation are very welcome and even a must when new features are implemented.
@@ -13,8 +14,7 @@ To update the documentation, edit one of the following markdown files or create
  - [best_practices.md](/docs/best_practices.md) 
 
 ## Render html
-To generate the site from markdown files, run the following R script with the `./docs` folder as working directory.
-Run this in a standalone R session, this is orders of magnitude faster compared to running in RStudio.
+To generate the site from markdown files, run the following R code with the `./docs` folder as working directory.
 
 ```R
 #devtools::install_github("ropenscilabs/icon")