diff --git a/.gitignore b/.gitignore index c82da53..a3ca5b3 100644 --- a/.gitignore +++ b/.gitignore @@ -4,6 +4,8 @@ /node_modules /.pnp .pnp.js +venv/ +docs/site/ # testing /coverage diff --git a/components/Header.tsx b/components/Header.tsx index 19b4297..39c3abf 100644 --- a/components/Header.tsx +++ b/components/Header.tsx @@ -38,7 +38,7 @@ export function Header(props: Headerprops) { Features Docs diff --git a/docs/docs/assets/css/custom.css b/docs/docs/assets/css/custom.css new file mode 100644 index 0000000..c4cccd4 --- /dev/null +++ b/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; +} diff --git a/docs/docs/index.md b/docs/docs/index.md new file mode 100644 index 0000000..4d68359 --- /dev/null +++ b/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 + +