feat: add docsify configuration

Result of 'docsify init ./docs' See https://docsify.js.org/#/quickstart Signed-off-by: Gianpaolo Macario <[email protected]>
arol-polito · Nov 18, 2024 · 4a9aad8 · 4a9aad8
1 parent 3214009
commit 4a9aad8
Show file tree

Hide file tree

Showing 3 changed files with 42 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,20 @@
+# python-project-template
+
+Project template suitable for Python development.
+
+This template provides a basic [Devevelopment Container](https://containers.dev/) with the following components:
+
+- [Ubuntu 24.04](https://ubuntu.com/)
+- [Python 3.12](https://www.python.org/)
+- [Poetry](https://python-poetry.org/)
+- [Visual Studio Code](https://code.visualstudio.com/) extensions: [Python](https://marketplace.visualstudio.com/items?itemName=ms-python.python), [Git Graph](https://marketplace.visualstudio.com/items?itemName=mhutchie.git-graph)
+
+## Copyright and license for "python-project-template"
+
+Copyright (C) 2024, [Gianpaolo Macario](https://github.com/gmacario), all rights reserved.
+
+### Source code license
+
+The source code contained in this repository and the executable distributions are licensed under the terms of the MIT license as detailed in the [LICENSE](LICENSE) file.
+
+<!-- EOF -->
diff --git a/docs/index.html b/docs/index.html
@@ -0,0 +1,22 @@
+<!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: ''
+    }
+  </script>
+  <!-- Docsify v4 -->
+  <script src="//cdn.jsdelivr.net/npm/docsify@4"></script>
+</body>
+</html>