Doc v0

docs/javascripts/gtag.js

@@ -0,0 +1,20 @@
+var gtag_id = ""; //"G-9B8BSP0VV7"; replace by GTAG if you want stats
+
+if (gtag_id === "") {
+  return;
+}
+
+var script = document.createElement("script");
+script.src = "https://www.googletagmanager.com/gtag/js?id=" + gtag_id;
+document.head.appendChild(script);
+
+location$.subscribe(function (url) {
+  window.dataLayer = window.dataLayer || [];
+
+  function gtag() {
+    dataLayer.push(arguments);
+  }
+
+  gtag("js", new Date());
+  gtag("config", gtag_id);
+});

docs/javascripts/quickfixes.js

@@ -0,0 +1,17 @@
+function hideHomeTitle() {
+        // Hide h1 containing Home (to have a nicer home page)
+        var h1s = document.querySelectorAll("h1");
+        for (var i = 0; i < h1s.length; i++) {
+            if (h1s[i].innerText === 'Home') {
+                h1s[i].style.display = 'none';
+            }
+        }
+}
+
+(window.onload = function () {
+    hideHomeTitle();
+    // So ugly setInterval: TODO: make that clean
+    setInterval(function () {
+        hideHomeTitle()
+    }, 1000);
+})

docs/javascripts/tables.js

@@ -0,0 +1,6 @@
+document$.subscribe(function () {
+    var tables = document.querySelectorAll("article table")
+    tables.forEach(function (table) {
+        new Tablesort(table)
+    })
+})

docs/stylesheets/extra.css

@@ -0,0 +1,76 @@
+/* stylelint-disable SelectorFormat, selector-class-pattern */
+.codetotal-banner {
+  height: 50px;
+  max-height: 150px;
+}
+
+.codetotal-logo {
+  height: 70px;
+  max-height: 70px;
+}
+
+.codetotal-icon {
+  max-height: 32px;
+  max-width: 32px;
+}
+
+.md-typeset__table {
+  min-width: 100%;
+}
+
+.md-typeset table:not([class]) {
+  display: table;
+}
+
+/* light mode table header bgcolor */
+.md-typeset__table th {
+  background-color: #f2edfe;
+}
+
+/* dark mode table header bgcolor */
+[data-md-color-scheme="slate"] .md-typeset__table th {
+  background-color: hsla(var(--md-hue),25%,25%,1)
+}
+
+/* light mode alternating table bg colors */
+.md-typeset__table tr:nth-child(2n) {
+  background-color: #f8f8f8;
+}
+
+/* dark mode alternating table bg colors */
+[data-md-color-scheme="slate"] .md-typeset__table tr:nth-child(2n) {
+  background-color: hsla(var(--md-hue),25%,25%,1)
+}
+
+h1[content~=Home] {
+  display: none;
+}
+
+:root>* {
+  --md-default-fg-color: #1E144D;
+  --md-default-fg-color--light: #6A2BFF;
+  --md-default-fg-color--lighter: #FD80CD ;
+  --md-default-fg-color--lightest: #dcc4d3;
+  --md-default-bg-color: #fff;
+  --md-default-bg-color--light: #fff;
+  --md-default-bg-color--lighter: #fff;
+  --md-default-bg-color--lightest: #fff;
+
+  --md-primary-fg-color: #1E144D;
+  --md-primary-fg-color--light: #FD80CD;
+  --md-primary-fg-color--dark: #6A2BFF;
+  --md-primary-bg-color: #fff;
+  --md-primary-bg-color--light: #fff;
+
+
+  --md-accent-fg-color: #6A2BFF;
+  --md-accent-fg-color--transparent: #6A2BFF;
+  --md-accent-bg-color: #B95CE4;
+  --md-accent-bg-color--light: #FD80CD;
+
+  --md-footer-bg-color: #B95CE4;
+
+  --md-typeset-table-color--light: #fff5fb;
+
+}
+

mkdocs.yml

@@ -0,0 +1,62 @@
+---
+site_name: CodeTotal by OX Security
+site_url: https://codetotal.io
+repo_url: https://github.com/oxsecurity/codetotal
+edit_uri: tree/main/docs
+site_author: Nicolas Vuillamy
+# site_description-start
+site_description: 
+# site_description-end
+copyright: Copyright &copy; 2022 <a href="https://www.ox.security/?ref=codetotal" target= "_blank">OX Security</a>
+theme:
+  name: material
+  font: 
+    text: Satoshi, sans-serif
+  custom_dir: docs/overrides
+  features:
+    - navigation.instant
+    - navigation.footer
+  logo: assets/images/ox-icon.jpg
+  favicon: assets/images/ox-icon.jpg
+  palette:
+    primary: white
+plugins:
+  - glightbox
+  - search
+markdown_extensions:
+  - pymdownx.emoji:
+      emoji_index: !!python/name:materialx.emoji.twemoji
+      emoji_generator: !!python/name:materialx.emoji.to_svg
+  - pymdownx.snippets:
+      base_path: docs
+      check_paths: true
+  - mdx_truly_sane_lists
+  - attr_list
+extra_javascript:
+  - https://cdnjs.cloudflare.com/ajax/libs/tablesort/5.2.1/tablesort.min.js
+  - javascripts/tables.js
+#  - javascripts/gtag.js
+#  - javascripts/version-mike.js
+  - javascripts/quickfixes.js
+extra_css:
+  - stylesheets/extra.css
+extra:
+  social:
+    - icon: fontawesome/brands/linkedin
+      link: https://www.linkedin.com/company/ox-security/
+    - icon: fontawesome/regular/circle-question
+      link: https://github.com/oxsecurity/codetotal/issues
+      title: Need help ? Post an issue :)
+    - icon: fontawesome/brands/github
+      link: https://github.com/oxsecurity/codetotal
+    - icon: fontawesome/brands/docker
+      link: https://hub.docker.com/r/oxsecurity/codetotal
+  generator: false
+nav:
+  - "Home": "index.md"
+  - "Quick Start": "quick-start.md"
+  - "Contribute": "contributing.md"
+  - "License":
+      - "AGPL V3 License": "license.md"
+      - "License explanations": "license-explanations.md"
+  - "Changelog": "CHANGELOG.md"