From a6846d8cd69a714670eac2a924bbe6b6fd0f8b5f Mon Sep 17 00:00:00 2001 From: candifloss Date: Fri, 27 Dec 2024 08:05:58 +0530 Subject: [PATCH] Installed mkdocs --- .gitmodules | 3 +++ docs/index.md | 17 +++++++++++++++++ mkdocs-material | 1 + mkdocs.yml | 1 + 4 files changed, 22 insertions(+) create mode 100644 .gitmodules create mode 100644 docs/index.md create mode 160000 mkdocs-material create mode 100644 mkdocs.yml diff --git a/.gitmodules b/.gitmodules new file mode 100644 index 0000000..63f0fbb --- /dev/null +++ b/.gitmodules @@ -0,0 +1,3 @@ +[submodule "mkdocs-material"] + path = mkdocs-material + url = https://github.com/squidfunk/mkdocs-material.git diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..000ea34 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,17 @@ +# Welcome to MkDocs + +For full documentation visit [mkdocs.org](https://www.mkdocs.org). + +## Commands + +* `mkdocs new [dir-name]` - Create a new project. +* `mkdocs serve` - Start the live-reloading docs server. +* `mkdocs build` - Build the documentation site. +* `mkdocs -h` - Print help message and exit. + +## Project layout + + mkdocs.yml # The configuration file. + docs/ + index.md # The documentation homepage. + ... # Other markdown pages, images and other files. diff --git a/mkdocs-material b/mkdocs-material new file mode 160000 index 0000000..20c7631 --- /dev/null +++ b/mkdocs-material @@ -0,0 +1 @@ +Subproject commit 20c76314864e778911c5b3b819868e3f8ee1bc4d diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..c97182f --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1 @@ +site_name: My Docs