Skip to content

Commit

Permalink
Changed theme and added home.
Browse files Browse the repository at this point in the history 
Signed-off-by: aryan <[email protected]>
  • Loading branch information
@aryan-bhokare
aryan-bhokare committed Jun 18, 2024
1 parent a7f0117 commit 9ebb965
Show file tree
Hide file tree
Showing 4 changed files with 199 additions and 95 deletions.
147 changes: 147 additions & 0 deletions docs/assets/css/custom.css
View file
Original file line number Diff line number Diff line change
@@ -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;
}
2 changes: 0 additions & 2 deletions docs/index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@ For full documentation visit [mkdocs.org](https://www.mkdocs.org).

## Commands

bb

- `mkdocs new [dir-name]` - Create a new project.
- `mkdocs serve` - Start the live-reloading docs server.
- `mkdocs build` - Build the documentation site.
Expand Down
Binary file added docs/static/intel_owl_negative.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
145 changes: 52 additions & 93 deletions mkdocs.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ repo_url: https://github.com/intelowlproject/docs

nav:
- IntelOwl:
- Home: "IntelOwl/docs/index.md"
- Introduction: "IntelOwl/docs/introduction.md"
- Installation: "IntelOwl/docs/installation.md"
- Advanced Configuration: "IntelOwl/docs/advanced_configuration.md"
Expand All @@ -30,103 +31,61 @@ plugins:
- mkdocstrings
theme:
name: material
custom_dir: overrides
logo: static/intel_owl_negative.png
features:
- announce.dismiss
- navigation.tabs
- navigation.path
- navigation.footer
- navigation.expand
- content.action.edit
- content.action.view
- content.code.annotate
- content.code.copy
- content.tabs.link
- content.tooltips
- navigation.footer
- navigation.indexes
# - navigation.sections
- navigation.tabs
- navigation.tabs.sticky
- navigation.top
- search.highlight
- search.share
- search.suggest
# - toc.follow
language: en
palette:
- scheme: default
primary: indigo
accent: indigo
toggle:
icon: material/brightness-7
name: Switch to dark mode
- scheme: slate
primary: indigo
accent: indigo
toggle:
icon: material/brightness-4
name: Switch to light mode
shortcuts:
help: 191 # ?
next: 78 # n
previous: 80 # p
search: 83 # s
scheme: filigran
font:
text: Roboto
text: IBM Plex Sans
code: Roboto Mono
icon:
logo: "material/library"
repo: "material/library"
admonition:
note: octicons/tag-16
abstract: octicons/checklist-16
info: octicons/info-16
tip: octicons/flame-16
success: octicons/check-16
question: octicons/question-16
warning: octicons/alert-16
failure: octicons/x-circle-16
danger: octicons/zap-16
bug: octicons/bug-16
example: octicons/beaker-16
quote: octicons/quote-16
data: octicons/database-16
squirell: octicons/squirrel-16
goal: octicons/goal-16
rocket: octicons/rocket-16
# markdown_extensions:
# - abbr
# - admonition
# - attr_list
# - def_list
# - footnotes
# - md_in_html
# - markdown_inline_graphviz
# - mdx_truly_sane_lists
# - plantuml_markdow n
# - tables
# - pymdownx.critic
# - pymdownx.caret
# - pymdownx.details
# - pymdownx.extra
# - pymdownx.inlinehilite
# - pymdownx.keys
# - pymdownx.mark
# - pymdownx.magiclink
# - pymdownx.smartsymbols
# - pymdownx.snippets
# - pymdownx.tilde
# - toc:
# permalink: true
# - pymdownx.arithmatex:
# generic: true
# - pymdownx.betterem:
# smart_enable: all
# - pymdownx.emoji:
# emoji_index: !!python/name:materialx.emoji.twemoji
# emoji_generator: !!python/name:materialx.emoji.to_svg
# options:
# custom_icons:
# - overrides/.icons
# - pymdownx.highlight:
# anchor_linenums: true
# line_spans: __span
# pygments_lang_class: true
# - pymdownx.tabbed:
# alternate_style: true
# - pymdownx.tasklist:
# custom_checkbox: true
# CSS
extra_css:
- assets/css/custom.css
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

0 comments on commit 9ebb965

Please sign in to comment.