Merge pull request #17 from arol-polito/10-feat-generate-documentatio…

…n-using-docsify feat: generate documentation using docsify
arol-polito · Nov 18, 2024 · e905350 · e905350
2 parents 809a63b + 35e5571
commit e905350
Show file tree

Hide file tree

Showing 4 changed files with 43 additions and 0 deletions.
diff --git a/docs/.nojekyll b/docs/.nojekyll
diff --git a/docs/README.md b/docs/README.md
@@ -0,0 +1,5 @@
+# python-project-template
+
+See upstream GitHub repository: <https://github.com/arol-polito/python-project-template>
+
+<!-- EOF -->
diff --git a/docs/_sidebar.md b/docs/_sidebar.md
@@ -0,0 +1,8 @@
+<!-- docs/_sidebar.md -->
+
+<!-- markdownlint-disable MD041 -->
+
+- [Home](/)
+- [HOWTO Create a GitHub repository from template](howto-create-repository-from-template.md)
+
+<!-- EOF -->
diff --git a/docs/index.html b/docs/index.html
@@ -0,0 +1,30 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <title>Document</title>
+    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
+    <meta name="description" content="Description" />
+    <meta
+      name="viewport"
+      content="width=device-width, initial-scale=1.0, minimum-scale=1.0"
+    />
+    <link
+      rel="stylesheet"
+      href="//cdn.jsdelivr.net/npm/docsify@4/lib/themes/vue.css"
+    />
+  </head>
+
+  <body>
+    <div id="app"></div>
+    <script>
+      window.$docsify = {
+        name: "",
+        repo: "",
+        loadSidebar: true,
+      };
+    </script>
+    <!-- Docsify v4 -->
+    <script src="//cdn.jsdelivr.net/npm/docsify@4"></script>
+  </body>
+</html>