task: remove mkdocs, add jekyll

.github/workflows/jekyll-gh-pages.yml

@@ -0,0 +1,52 @@
+# Sample workflow for building and deploying a Jekyll site to GitHub Pages
+name: Deploy Jekyll with GitHub Pages dependencies preinstalled
+
+on:
+  # Runs on pushes targeting the default branch
+  push:
+    branches: ["main"]
+    paths: ['**.md']
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  # Build job
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+      - name: Build with Jekyll
+        uses: actions/jekyll-build-pages@v1
+        with:
+          source: ./
+          destination: ./_site
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+
+  # Deployment job
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

CONTRIBUTING.md

@@ -0,0 +1,19 @@
+## Contributing
+
+Clone the project and open it in you favorite IDE.
+
+```bash
+git clone git@github.com:svaponi/hello-pypi.git
+```
+
+Install dependencies with [Poetry](https://python-poetry.org/docs/#installation).
+
+````sh
+poetry install
+````
+
+Run the tests.
+
+```shell
+python -m pytest
+```

README.md

@@ -1,3 +1,17 @@
-# fastapi-boilerplate
+# FastAPI Boilerplate
 
-Kickstart your [FastAPI](https://fastapi.tiangolo.com/) development with ease.
+[![Test](https://github.com/svaponi/fastapi-boilerplate/actions/workflows/run-tests.yml/badge.svg)](https://github.com/svaponi/fastapi-boilerplate/actions/workflows/run-tests.yml)
+[![Coverage Status](https://coveralls.io/repos/github/svaponi/fastapi-boilerplate/badge.svg?branch=main)](https://coveralls.io/github/svaponi/fastapi-boilerplate?branch=main)
+
+Boilerplate repository to kickstart 🚀 your [FastAPI](https://fastapi.tiangolo.com/) project.
+
+### Key features
+
+- Run [pytest](https://docs.pytest.org/) when you **push changes to `src/` dir** ([GitHub Actions](/.github/workflows/run-tests.yml)).
+- [Poetry](https://python-poetry.org/docs/#installation) as **dependency manager** and **packaging tool**.
+- [Coveralls](https://docs.coveralls.io/) integration (for coverage badge).
+
+
+## Contributing
+
+See [CONTRIBUTING.md](/CONTRIBUTING.md).

_config.yml

@@ -0,0 +1,2 @@
+name: true
+title: false