Improvements in Website.

Fixed Images not rendering issue. Added Social Media Links. Added some more features. Signed-off-by: aryan <[email protected]>
intelowlproject · Jun 19, 2024 · ac0e4ad · ac0e4ad
1 parent 02e86d1
commit ac0e4ad
Show file tree

Hide file tree

Showing 5 changed files with 230 additions and 13 deletions.
diff --git a/docs/index.md b/docs/index.md
@@ -1,17 +1,46 @@
-# Welcome to MkDocs
+---
+hide:
+  - navigation
+  - toc
+---
 
-For full documentation visit [mkdocs.org](https://www.mkdocs.org).
+# IntelOwl Centralised Documentation
 
-## Commands
+Welcome to the IntelOwl Centralised Documentation. Here you will be able to find all documentation for all projects under IntelOwl.
 
-- `mkdocs new [dir-name]` - Create a new project.
-- `mkdocs serve` - Start the live-reloading docs server.
-- `mkdocs build` - Build the documentation site.
-- `mkdocs -h` - Print help message and exit.
+## Introduction
 
-## Project layout
+Intel Owl is an Open Source Intelligence, or OSINT solution, to get Threat Intelligence data about a specific digital artifact from a single API at scale. It integrates a high number of services available online and a lot of cutting-edge malware analysis tools. It is for everyone who needs a single point to query for info about a specific file or observable. If you are a Security Analyst, do not waste any more time in performing enrichment tasks! IntelOwl saves your time and allows you to concentrate on more serious tasks.
 
-    mkdocs.yml    # The configuration file.
-    docs/
-        index.md  # The documentation homepage.
-        ...       # Other markdown pages, images and other files.
+## Getting started
+
+<div class="grid cards" markdown>
+
+- :material-rocket-launch-outline:{ .lg .middle } **Introduction**
+  [:octicons-arrow-right-24:{ .middle } More](IntelOwl/docs/introduction.md)
+
+- :fontawesome-regular-compass:{ .lg .middle } **Installation**
+  [:octicons-arrow-right-24:{ .middle } More](IntelOwl/docs/installation.md)
+
+- :material-rocket-launch-outline:{ .lg .middle } **Contribute**
+  [:octicons-arrow-right-24:{ .middle } More](IntelOwl/docs/contribute.md)
+
+- :material-tune-vertical:{ .lg .middle } **Usage**
+  [:octicons-arrow-right-24:{ .middle } More](IntelOwl/docs/usage.md)
+
+- :fontawesome-regular-compass:{ .lg .middle } **Advanced Usage**
+  [:octicons-arrow-right-24:{ .middle } More](IntelOwl/docs/advanced_usage.md)
+
+- :material-tune-vertical:{ .lg .middle } **Advanced Configuration**
+  [:octicons-arrow-right-24:{ .middle } More](IntelOwl/docs/advanced_configuration.md)
+
+</div>
+
+!!! info "Need more help?"
+
+    We are doing our best to keep this documentation complete, accurate and up to date.
+
+    If you still have questions or you find something which is not sufficiently explained, join the [IntelOwl channel under HoneyNet Community on Slack](https://join.slack.com/t/honeynetpublic/shared_invite/zt-2b6e419q9-oGyoKAE99WuDAQAfh0_Wyw).
+
+</div>
+<br /><br /><br />
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -9,8 +9,8 @@ repo_name: intelowlproject/docs
 repo_url: https://github.com/intelowlproject/docs
 
 nav:
+  - Home: "index.md"
   - IntelOwl:
-      - Home: "IntelOwl/docs/index.md"
       - Introduction: "IntelOwl/docs/introduction.md"
       - Installation: "IntelOwl/docs/installation.md"
       - Advanced Configuration: "IntelOwl/docs/advanced_configuration.md"
@@ -29,6 +29,7 @@ plugins:
       separator: '[\s\-,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
   - monorepo
   - mkdocstrings
+
 theme:
   name: material
   # custom_dir: overrides
@@ -48,9 +49,28 @@ theme:
   font:
     text: IBM Plex Sans
     code: Roboto Mono
+
 # CSS
 extra_css:
   - assets/css/custom.css
+
+extra:
+  version:
+    provider: mike
+  analytics:
+    provider: google
+    property: G-DB4K9LZPDZ
+  generator: false
+  social:
+    - icon: fontawesome/brands/github
+      link: https://github.com/intelowlproject
+    - icon: fontawesome/brands/slack
+      link: https://honeynetpublic.slack.com/archives/C01KVGMAKL6
+    - icon: fontawesome/brands/linkedin
+      link: https://www.linkedin.com/company/intelowl
+    - icon: fontawesome/brands/twitter
+      link: https://x.com/intel_owl
+
 markdown_extensions:
   - attr_list
   - md_in_html

diff --git a/overrides/main.html b/overrides/main.html
@@ -0,0 +1,8 @@
+{% extends "base.html" %}
+
+{% block outdated %}
+  You're not viewing the latest version.
+  <a href="{{ '../' ~ base_url }}"> 
+    <strong>Click here to go to latest.</strong>
+  </a>
+{% endblock %}
diff --git a/overrides/partials/comments.html b/overrides/partials/comments.html
@@ -0,0 +1,19 @@
+{% if page.meta.comments %}
+  <h2 id="__comments">{{ lang.t("meta.comments") }}</h2>
+  <!-- Insert generated snippet here -->
+  <script src="https://giscus.app/client.js"
+        data-repo="OpenCTI-Platform/docs"
+        data-repo-id="R_kgDOJf09JA"
+        data-category="General"
+        data-category-id="DIC_kwDOJf09JM4CWeSn"
+        data-mapping="pathname"
+        data-strict="0"
+        data-reactions-enabled="1"
+        data-emit-metadata="0"
+        data-input-position="bottom"
+        data-theme="transparent_dark"
+        data-lang="fr"
+        crossorigin="anonymous"
+        async>
+  </script>
+{% endif %}
diff --git a/overrides/partials/header.html b/overrides/partials/header.html
@@ -0,0 +1,141 @@
+{% set class = "md-header" %}
+{% if "navigation.tabs.sticky" in features %}
+  {% set class = class ~ " md-header--shadow md-header--lifted" %}
+{% elif "navigation.tabs" not in features %}
+  {% set class = class ~ " md-header--shadow" %}
+{% endif %}
+
+<!-- Header -->
+<header class="{{ class }}" data-md-component="header">
+  <nav
+    class="md-header__inner md-grid"
+    aria-label="{{ lang.t('header') }}"
+  >
+
+    <!-- Link to home -->
+    <a
+      href="{{ config.extra.homepage | d(nav.homepage.url, true) | url }}"
+      title="{{ config.site_name | e }}"
+      class="md-header__button md-logo"
+      aria-label="{{ config.site_name }}"
+      data-md-component="logo"
+    >
+      {% include "partials/logo.html" %}
+    </a>
+
+    <!-- Button to open drawer -->
+    <label class="md-header__button md-icon" for="__drawer">
+      {% include ".icons/material/menu" ~ ".svg" %}
+    </label>
+
+    <!-- Header title -->
+    <div class="md-header__title" data-md-component="header-title">
+      <div class="md-header__ellipsis">
+        <div class="md-header__topic">
+          <span class="md-ellipsis">
+
+          </span>
+        </div>
+        <div class="md-header__topic" data-md-component="header-topic">
+          <span class="md-ellipsis">
+
+          </span>
+        </div>
+      </div>
+    </div>
+
+    <!-- Color palette -->
+    {% if config.theme.palette %}
+      {% if not config.theme.palette is mapping %}
+        <form class="md-header__option" data-md-component="palette">
+          {% for option in config.theme.palette %}
+            {% set scheme  = option.scheme  | d("default", true) %}
+            {% set primary = option.primary | d("indigo", true) %}
+            {% set accent  = option.accent  | d("indigo", true) %}
+            <input
+              class="md-option"
+              data-md-color-media="{{ option.media }}"
+              data-md-color-scheme="{{ scheme | replace(' ', '-') }}"
+              data-md-color-primary="{{ primary | replace(' ', '-') }}"
+              data-md-color-accent="{{ accent | replace(' ', '-') }}"
+              {% if option.toggle %}
+                aria-label="{{ option.toggle.name }}"
+              {% else  %}
+                aria-hidden="true"
+              {% endif %}
+              type="radio"
+              name="__palette"
+              id="__palette_{{ loop.index }}"
+            />
+            {% if option.toggle %}
+              <label
+                class="md-header__button md-icon"
+                title="{{ option.toggle.name }}"
+                for="__palette_{{ loop.index0 or loop.length }}"
+                hidden
+              >
+                {% include ".icons/" ~ option.toggle.icon ~ ".svg" %}
+              </label>
+            {% endif %}
+          {% endfor %}
+        </form>
+      {% endif %}
+    {% endif %}
+
+    <!-- Site language selector -->
+    {% if config.extra.alternate %}
+      <div class="md-header__option">
+        <div class="md-select">
+          {% set icon = config.theme.icon.alternate or "material/translate" %}
+          <button
+            class="md-header__button md-icon"
+            aria-label="{{ lang.t('select.language') }}"
+          >
+            {% include ".icons/" ~ icon ~ ".svg" %}
+          </button>
+          <div class="md-select__inner">
+            <ul class="md-select__list">
+              {% for alt in config.extra.alternate %}
+                <li class="md-select__item">
+                  <a
+                    href="{{ alt.link | url }}"
+                    hreflang="{{ alt.lang }}"
+                    class="md-select__link"
+                  >
+                    {{ alt.name }}
+                  </a>
+                </li>
+              {% endfor %}
+            </ul>
+          </div>
+        </div>
+      </div>
+    {% endif %}
+
+    <!-- Button to open search modal -->
+    {% if "material/search" in config.plugins %}
+      <label class="md-header__button md-icon" for="__search">
+        {% include ".icons/material/magnify.svg" %}
+      </label>
+
+      <!-- Search interface -->
+      {% include "partials/search.html" %}
+    {% endif %}
+
+    <!-- Repository information -->
+    {% if config.repo_url %}
+      <div class="md-header__source">
+        {% include "partials/source.html" %}
+      </div>
+    {% endif %}
+  </nav>
+
+  <!-- Navigation tabs (sticky) -->
+  {% if "navigation.tabs.sticky" in features %}
+    {% if "navigation.tabs" in features %}
+      {% include "partials/tabs.html" %}
+    {% endif %}
+  {% endif %}
+
+  <!-- Start of Reo Javascript --> <script type="text/javascript"> !function(){var e,t,n;e="58d967e3f3ca784",t=function(){Reo.init({clientID:"58d967e3f3ca784"})},(n=document.createElement("script")).src="https://static.reo.dev/"+e+"/reo.js",n.async=!0,n.onload=t,document.head.appendChild(n)}(); </script> <!-- End of Reo Javascript -->
+</header>