Added static html

Signed-off-by: aryan <[email protected]>

.gitignore

@@ -4,6 +4,8 @@
 /node_modules
 /.pnp
 .pnp.js
+venv/
+docs/site/
 
 # testing
 /coverage

components/Header.tsx

@@ -38,7 +38,7 @@ export function Header(props: Headerprops) {
               Features
             </Link>
             <Link
-              href="https://intelowl.readthedocs.io/en/latest"
+              href="site/index.html"
               className="text-white font-SpaceGrotesk font-light text-center invisible md:visible"
             >
               Docs

docs/docs/assets/css/custom.css

@@ -0,0 +1,147 @@
+/* Color scheme */
+
+[data-md-color-scheme="filigran"] {
+  /* Primary color shades */
+  --md-primary-fg-color: #;
+  --md-primary-fg-color--light: #;
+  --md-primary-fg-color--dark: #;
+  --md-primary-bg-color: #;
+  --md-primary-bg-color--light: #;
+
+  /* Accent color shades */
+  --md-accent-fg-color: #1bb6ff;
+  --md-accent-fg-color--transparent: #;
+  --md-accent-bg-color: #;
+  --md-accent-bg-color--light: #;
+
+  /* Default color shades */
+  --md-default-fg-color: #00b1ff;
+  --md-default-fg-color--light: #697a94;
+  --md-default-fg-color--lighter: #3d4e66;
+  --md-default-fg-color--lightest: #03305d;
+  --md-default-bg-color: #070d19;
+  --md-default-bg-color--light: #0f1e38;
+  --md-default-bg-color--lighter: #152849;
+  --md-default-bg-color--lightest: #09101e;
+
+  /* Code color shades */
+  --md-code-fg-color: #ffffff;
+  --md-code-fg-color--light: #1bb6ff;
+  --md-code-bg-color: #001e3c;
+  --md-code-bg-color--light: #001e3c;
+  --md-code-bg-color--lighter: #001e3c;
+
+  /* Code highlighting color shades */
+  --md-code-hl-operator-color: #9ccc65;
+  --md-code-hl-punctuation-color: #cddc39;
+  --md-code-hl-comment-color: #3d4e66;
+  --md-code-hl-variable-color: #9ccc65;
+  --md-code-hl-name-color: #ffb300;
+
+  /* Typeset color shades */
+  --md-typeset-color: #ffffff;
+
+  /* Typeset `a` color shades */
+  --md-typeset-a-color: #0fbcff;
+
+  /* Typeset `mark` color shades */
+  --md-typeset-mark-color: #;
+
+  /* Typeset `del` and `ins` color shades */
+  --md-typeset-del-color: #;
+  --md-typeset-ins-color: #;
+
+  /* Typeset `kbd` color shades */
+  --md-typeset-kbd-color: #;
+  --md-typeset-kbd-accent-color: #;
+  --md-typeset-kbd-border-color: #;
+
+  /* Typeset `table` color shades */
+  --md-typeset-table-color: #0082d1;
+  --md-typeset-table-color--light: #051629;
+
+  /* Admonition color shades */
+  --md-admonition-fg-color: #ffffff;
+  --md-admonition-bg-color: var(--md-default-bg-color);
+
+  /* Warning color shades */
+  --md-warning-fg-color: #;
+  --md-warning-bg-color: #;
+
+  /* Footer color shades */
+  --md-footer-fg-color: #;
+  --md-footer-fg-color--light: #;
+  --md-footer-fg-color--lighter: #;
+  --md-footer-bg-color: #011222;
+  --md-footer-bg-color--dark: #09101e;
+}
+
+/* Header */
+.md-header,
+.md-tabs {
+  background-color: #09101e !important;
+}
+
+/* Cards */
+.md-typeset .grid.cards > ol > li,
+.md-typeset .grid.cards > ul > li,
+.md-typeset .grid > .card {
+  border: none !important;
+  background-color: #001e3c !important;
+  border-radius: 10px;
+}
+
+.md-typeset .grid.cards > ol > li:focus-within,
+.md-typeset .grid.cards > ol > li:hover,
+.md-typeset .grid.cards > ul > li:focus-within,
+.md-typeset .grid.cards > ul > li:hover,
+.md-typeset .grid > .card:focus-within,
+.md-typeset .grid > .card:hover {
+  border: none !important;
+  background-color: #001e3c !important;
+  border-radius: 10px;
+}
+
+html .md-footer-meta.md-typeset a:focus,
+html .md-footer-meta.md-typeset a:hover {
+  color: #0fbcff !important;
+}
+
+.middle {
+  margin: -5px 5px 0 0 !important;
+}
+
+.md-header__button.md-logo img,
+.md-header__button.md-logo svg {
+  height: 1.5rem;
+}
+
+.grid {
+  column-gap: 0.8rem !important;
+}
+
+.md-typeset__table {
+  min-width: 100%;
+}
+
+.md-typeset table:not([class]) {
+  display: table;
+}
+
+.md-typeset__table td,
+th {
+  white-space: nowrap;
+}
+
+/* Works on Chrome, Edge, and Safari */
+html,
+body {
+  scrollbar-color: #070d19 #0f1e38;
+  scrollbarwidth: thin;
+  webkitfontsmoothing: auto;
+}
+
+.glightbox img {
+  border: 1px solid #273d5f;
+  border-radius: 4.8px;
+}

docs/docs/index.md

@@ -0,0 +1,46 @@
+---
+hide:
+  - navigation
+  - toc
+---
+
+# IntelOwl Centralised Documentation
+
+Welcome to the IntelOwl Centralised Documentation. Here you will be able to find all documentation for all projects under IntelOwl.
+
+## Introduction
+
+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.
+
+## 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 />

docs/mkdocs.yml

@@ -0,0 +1,117 @@
+site_name: IntelOwl Documentation
+site_description: "A centralised documentation for all the projects under IntelOwl."
+site_author: "Matteo Lodi"
+
+copyright: |
+  © Matteo Lodi
+
+repo_name: intelowlproject/docs
+repo_url: https://github.com/intelowlproject/docs
+
+nav:
+  - Home: "index.md"
+  - IntelOwl:
+      - Introduction: "IntelOwl/docs/introduction.md"
+      - Installation: "IntelOwl/docs/installation.md"
+      - Advanced Configuration: "IntelOwl/docs/advanced_configuration.md"
+      - Usage: "IntelOwl/docs/usage.md"
+      - Advanced Usage: "IntelOwl/docs/advanced_usage.md"
+      - Contribute: "IntelOwl/docs/contribute.md"
+      - API docs: "IntelOwl/docs/api_docs.md"
+  - GreedyBear:
+      - index: "GreedyBear/index.md"
+  - PyIntelOwl:
+      - index: "pyintelowl/index.md"
+  - GoIntelOwl:
+      - index: "go-intelowl/index.md"
+plugins:
+  - search:
+      separator: '[\s\-,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
+  - monorepo
+  - mkdocstrings
+  - swagger-ui-tag:
+      background: white
+      docExpansion: none
+      filter: true
+      syntaxHighlightTheme: monokai
+      # tryItOutEnabled: true
+
+theme:
+  name: material
+  # custom_dir: overrides
+  logo: static/intel_owl_negative.png
+  features:
+    - navigation.tabs
+    - navigation.path
+    - navigation.footer
+    - navigation.expand
+    - content.action.edit
+    - content.action.view
+    - content.code.annotate
+    - content.code.copy
+    - search.highlight
+  palette:
+    scheme: filigran
+  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
+  - tables
+  - admonition
+  - def_list
+  - pymdownx.inlinehilite
+  - pymdownx.snippets
+  - pymdownx.superfences
+  - pymdownx.details
+  - pymdownx.superfences
+  - pymdownx.smartsymbols
+  - pymdownx.critic
+  - pymdownx.caret
+  - pymdownx.keys
+  - pymdownx.mark
+  - pymdownx.tilde
+  - pymdownx.betterem
+  - pymdownx.superfences:
+      custom_fences:
+        - name: mermaid
+          class: mermaid
+          format: !!python/name:pymdownx.superfences.fence_code_format
+  - pymdownx.tabbed:
+      alternate_style: true
+  - pymdownx.highlight:
+      use_pygments: true
+      anchor_linenums: true
+      line_spans: __span
+      pygments_lang_class: false
+      auto_title: false
+  - pymdownx.emoji:
+      emoji_index: !!python/name:materialx.emoji.twemoji
+      emoji_generator: !!python/name:materialx.emoji.to_svg
+  - pymdownx.tasklist:
+      custom_checkbox: true
+  - pymdownx.snippets:
+      url_download: true

docs/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 %}

docs/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 %}