Logo and docs

vertexclique · Jan 20, 2024 · 0eab4c8 · 0eab4c8
1 parent bd95366
commit 0eab4c8
Show file tree

Hide file tree

Showing 12 changed files with 105 additions and 0 deletions.
diff --git a/docs/.firebaserc b/docs/.firebaserc
@@ -0,0 +1,5 @@
+{
+  "projects": {
+    "default": "nuclei"
+  }
+}
diff --git a/docs/.gitignore b/docs/.gitignore
@@ -0,0 +1 @@
+.idea/
diff --git a/docs/.nojekyll b/docs/.nojekyll
diff --git a/docs/_coverpage.md b/docs/_coverpage.md
@@ -0,0 +1,5 @@
+# <img src="https://raw.githubusercontent.com/vertexclique/nuclei/master/img/nuclei-logo.png">
+PROACTIVE IO & RUNTIME SYSTEM <small>est. 2019</small>
+
+[![](assets/img/github.svg) GitHub](https://github.com/vertexclique/nuclei)
+[![](assets/img/sitemap-solid.svg) What is Nuclei?](https://vertexclique.github.io/nuclei/)
diff --git a/docs/assets/img/github.svg b/docs/assets/img/github.svg
diff --git a/docs/assets/img/sitemap-solid.svg b/docs/assets/img/sitemap-solid.svg
diff --git a/docs/firebase.json b/docs/firebase.json
@@ -0,0 +1,10 @@
+{
+  "hosting": {
+    "public": ".",
+    "ignore": [
+      "firebase.json",
+      "**/.*",
+      "**/node_modules/**"
+    ]
+  }
+}
diff --git a/docs/index.html b/docs/index.html
@@ -0,0 +1,74 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="utf-8">
+  <meta http-equiv="X-UA-Compatible" content="IE=edge">
+  <meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1.0, shrink-to-fit=no, viewport-fit=cover">
+  <meta name="description" content="">
+  <title></title>
+
+  <!-- Themes (light + dark) -->
+  <link rel="stylesheet" media="(prefers-color-scheme: dark)" href="https://cdn.jsdelivr.net/npm/docsify-themeable@0/dist/css/theme-simple-dark.css">
+
+  <!-- PrismJS theme -->
+  <link rel="stylesheet" href="https://unpkg.com/[email protected]/themes/prism-night-owl.min.css">
+
+  <!-- Custom Styles -->
+  <style>
+    :root {
+      --theme-hue: 120;
+      --theme-color: rgb(106, 25, 205);
+      /* <a href="https://ibb.co/mhM4z6P"><img src="https://i.ibb.co/DwSQK5j/vibrant-obelisk.png" alt="vibrant-obelisk" border="0"></a> */
+      --cover-background-color: #00000000;
+      --cover-background-image: url(https://s13.gifyu.com/images/S0ULN.gif);
+      --cover-button-background: rgb(118, 198, 251);
+      --cover-button-border: rgb(118, 198, 251);
+      --cover-button-border: 1px solid var(--theme-color);
+      --cover-heading-color: rgb(106, 25, 205);
+      --cover-heading-font-size: 100px;
+      --cover-heading-font-size-min: ;
+      --cover-heading-font-size-max: 500px;
+    }
+  </style>
+</head>
+<body>
+<div id="app"></div>
+
+<script>
+  // Docsify Configuration
+  window.$docsify = {
+    // GENERAL
+    // -----------------------------------------------------------------
+    name       : 'Nuclei - Proactive IO & Runtime system',
+    repo: 'vertexclique/nuclei',
+    coverpage  : 'coverpage.md',
+    homepage   : 'introduction.md',
+    loadSidebar: 'sidebar.md',
+
+    coverpage: true,
+    themeable: {
+      readyTransition : true, // default
+      responsiveTables: true  // default
+    }
+  };
+</script>
+
+<!-- Required -->
+<script src="https://cdn.jsdelivr.net/npm/docsify@4/lib/docsify.min.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/docsify-themeable@0/dist/js/docsify-themeable.min.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/docsify-pagination.min.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/docsify-tabs.min.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/docsify-prism@latest/dist/docsify-prism.min.js"></script>
+
+<!-- CDN files for prism -->
+<script src="//unpkg.com/[email protected]/prism.js"></script>
+<script src="//unpkg.com/[email protected]/components/prism-rust.min.js"></script>
+<script src="//unpkg.com/[email protected]/components/prism-toml.min.js"></script>
+<script src="//unpkg.com/[email protected]/components/prism-python.min.js"></script>
+<script src="//unpkg.com/[email protected]/components/prism-json.min.js"></script>
+
+<!-- Recommended -->
+<script src="https://cdn.jsdelivr.net/npm/docsify@4/lib/plugins/search.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/docsify@4/lib/plugins/zoom-image.min.js"></script>
+</body>
+</html>
diff --git a/docs/introduction.md b/docs/introduction.md
@@ -0,0 +1 @@
+# Nuclei
diff --git a/docs/quickstart.md b/docs/quickstart.md
@@ -0,0 +1 @@
+# Quickstart Guide
diff --git a/docs/sidebar.md b/docs/sidebar.md
@@ -0,0 +1,6 @@
+<!-- markdownlint-disable-next-line first-line-heading -->
+- [Introduction](introduction)
+- [Quickstart Guide](quickstart)
+- **Internals**
+- [Design Principles](designprinciples)
+- [Recovery System](recosystem)
diff --git a/img/nuclei-logo.png b/img/nuclei-logo.png