Merge pull request #13 from aliceinwire/readme

mkdocs: Add mkdocs

.github/workflows/docs_publish.yml

@@ -0,0 +1,18 @@
+---
+name: Docs publish
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@v2
+        with:
+          python-version: 3.7
+      - run: pip install mkdocs-material
+      - run: mkdocs gh-deploy --force

docs/index.md

@@ -0,0 +1,3 @@
+# kci-dev
+
+kci-dev is a cmdline tool for interact with a enabled KernelCI server

mkdocs.yml

@@ -0,0 +1,34 @@
+---
+# Project Information
+site_name: kci-dev
+site_author: Arisu Tachibana
+site_description: >-
+    kci-dev is a cmdline tool for interact with a 
+    enabled KernelCI server.
+
+# Repository information
+repo_name: kernelci/kci-dev
+repo_url: https://github.com/kernelci/kci-dev
+edit_uri: ""
+
+# Configuration
+theme:
+  name: material
+  icon:
+    repo: fontawesome/brands/github
+  features:
+    - navigation.instant
+    - navigation.tabs
+  language: en
+
+# Footer
+extra:
+  social:
+    - icon: fontawesome/brands/github
+      link: https://github.com/kernelci
+      name: kernelci on GitHub
+
+# Page tree
+nav:
+  - Home:
+    - Introduction: index.md