Skip to content

Commit 93ecd2b

Browse files
Added initial mkdocs file
0 parents  commit 93ecd2b

File tree

3 files changed

+42
-0
lines changed

3 files changed

+42
-0
lines changed

.github/workflows/mkdocs-build.yml

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
name: Publish docs via GitHub Pages
2+
on:
3+
push:
4+
branches:
5+
- main
6+
7+
jobs:
8+
build:
9+
name: Deploy docs
10+
runs-on: ubuntu-latest
11+
steps:
12+
- name: Checkout main
13+
uses: actions/checkout@v2
14+
15+
- name: Deploy docs
16+
uses: mhausenblas/mkdocs-deploy-gh-pages@master
17+
env:
18+
GITHUB_TOKEN: ${{ secrets.ACTIONS_KEY_ORG_ADMIN }}
19+
CONFIG_FILE: ./mkdocs.yml
20+
EXTRA_PACKAGES: build-base

docs/index.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Overview
2+
3+
The Open Authenticator is an open source TOTP based hardware authenticator using ESP32. In layman's terms, this does what Google Authenticator or Authy does.

mkdocs.yml

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
site_name: open-authenticator
2+
site_author: Vedant Paranjape
3+
site_description: "Documentation for Open Authenticator"
4+
site_url: https://open-authenticator.github.io
5+
repo_url: https://github.com/Open-Authenticator
6+
7+
theme:
8+
name: readthedocs
9+
10+
nav:
11+
- Home: index.md
12+
13+
markdown_extensions:
14+
- admonition
15+
- codehilite
16+
- pymdownx.tabbed
17+
- pymdownx.superfences
18+
- pymdownx.smartsymbols
19+
- pymdownx.arithmatex

0 commit comments

Comments
 (0)