init mkdocs

Signed-off-by: nicole mikołajczyk <git@mkljczk.pl>
This commit is contained in:
nicole mikołajczyk
2025-11-21 19:24:18 +01:00
parent 885a714685
commit 795367f8c1
3 changed files with 38 additions and 0 deletions

View File

@ -32,6 +32,11 @@ jobs:
node-version: ${{ matrix.node-version }}
cache: 'pnpm'
- name: Setup Python
uses: actions/setup-python@v5
with:
python-version: 3.x
- name: Install deps
working-directory: .
run: pnpm install
@ -86,6 +91,14 @@ jobs:
working-directory: ./packages/pl-api
run: cp docs ../pl-fe/dist/pl-api-docs -r
- name: Build documentation
working-directory: .
run: pip install mkdocs-material mkdocs-include-markdown-plugin && mkdocs build
- name: Copy documentation
working-directory: .
run: cp site ../pl-fe/dist/docs -r
- name: Upload Github Pages artifact
uses: actions/upload-pages-artifact@v3
with:

4
docs/index.md Normal file
View File

@ -0,0 +1,4 @@
{%
include "../README.md"
start='\n\n'
%}

21
mkdocs.yml Normal file
View File

@ -0,0 +1,21 @@
site_name: pl-fe Documentation
site_url: https://pl.mkljczk.pl/docs/
theme:
name: material
language: en
font: false
features:
- header.autohide
palette:
- scheme: slate
toggle:
icon: material/brightness-7
name: Switch to light mode
- scheme: default
toggle:
icon: material/brightness-4
name: Switch to dark mode
plugins:
- search:
lang: en
- include-markdown