Add base of docs
This commit is contained in:
Mikołaj Pich
parent
05f8073499
commit
ecc58a4d8a
6 changed files with 209 additions and 0 deletions
33
.github/workflows/docs.yml
vendored
Normal file
33
.github/workflows/docs.yml
vendored
Normal file
|
|
@ -0,0 +1,33 @@
|
|||
name: Docs
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: [ master ]
|
||||
|
||||
jobs:
|
||||
docs:
|
||||
runs-on: ubuntu-latest
|
||||
timeout-minutes: 10
|
||||
steps:
|
||||
- uses: fkirc/skip-duplicate-actions@master
|
||||
- uses: actions/checkout@v3
|
||||
- uses: gradle/wrapper-validation-action@v1
|
||||
- uses: actions/setup-java@v3
|
||||
with:
|
||||
distribution: 'zulu'
|
||||
java-version: 11
|
||||
- uses: actions/cache@v3
|
||||
with:
|
||||
path: |
|
||||
~/.gradle/caches
|
||||
~/.gradle/wrapper
|
||||
key: gradle-${{ runner.os }}-${{ hashFiles('**/*.gradle*') }}
|
||||
- name: Generate docs
|
||||
run: ./gradlew mkdocsBuild
|
||||
- name: Deploy to GitHub Pages
|
||||
uses: JamesIves/github-pages-deploy-action@v4
|
||||
with:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
BRANCH: docs
|
||||
FOLDER: build/mkdocs
|
||||
CLEAN: true
|
||||
|
|
@ -4,7 +4,9 @@ plugins {
|
|||
alias(libs.plugins.serialization)
|
||||
id "org.jlleitschuh.gradle.ktlint" version "11.3.2"
|
||||
id "io.github.gradle-nexus.publish-plugin" version "1.3.0"
|
||||
id 'ru.vyarus.mkdocs' version '3.0.0'
|
||||
}
|
||||
mkdocs.sourcesDir = 'docs'
|
||||
|
||||
ext {
|
||||
SITE_URL = 'https://github.com/wulkanowy/sdk'
|
||||
|
|
|
|||
26
docs/docs/about/history.md
Normal file
26
docs/docs/about/history.md
Normal file
|
|
@ -0,0 +1,26 @@
|
|||
### 2.0.6 (2023.05.23)
|
||||
|
||||
* dodanie rozpoznawania strony błędu z aktualizacją bazy danych
|
||||
|
||||
### 2.0.5 (2023.05.23)
|
||||
|
||||
* aktualizacja retrofita do 2.10.0-SNAPSHOT, żeby naprawić błędy spowodowane przez R8 full mode w aplikacji
|
||||
|
||||
### 2.0.4 (2023.05.22)
|
||||
|
||||
* migracja z migbase64 na kotlin.io.encoding.Base64
|
||||
* aktualizacja kotlina do 1.8.21
|
||||
* wsparcie dla rozpoznawania nowych stron błędów z przerwą techniczną
|
||||
|
||||
### 2.0.3 (2023.05.12)
|
||||
|
||||
* fix autoryzacji poprzez dodanie brakujących nagłówków i ciasteczek do żądania z autoryzacją
|
||||
|
||||
### 2.0.1 (2023.05.12)
|
||||
|
||||
* fix pobierania zadań domowych z załącznikami, gdzie dziennik zaczął zwracać mniej danych niż kiedyś
|
||||
* dodanie metod umożliwiających sprawdzenie, czy uczeń został zautoryzowany oraz wykonanie jego autoryzacji w razie potrzeby
|
||||
|
||||
### 2.0.0 (2023.05.07)
|
||||
|
||||
* *Wersja bazowa*
|
||||
34
docs/docs/guide/installation.md
Normal file
34
docs/docs/guide/installation.md
Normal file
|
|
@ -0,0 +1,34 @@
|
|||
# Instalacja
|
||||
|
||||
[](https://search.maven.org/artifact/io.github.wulkanowy/sdk)
|
||||
|
||||
Ostatnią stabilną wersję SDK możesz łatwo pobrać z repozytorium Maven Central:
|
||||
|
||||
```groovy
|
||||
allprojects {
|
||||
repositories {
|
||||
mavenCentral()
|
||||
}
|
||||
}
|
||||
dependencies {
|
||||
implementation 'io.github.wulkanowy:sdk:2.0.61' // lub inna wersja, patrz na badge wyżej
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
|
||||
|
||||
W razie potrzeby możesz też pobrać wersję SNAPSHOT zawierającą jeszcze niewydane zmiany, które znajdą się w następnej wersji:
|
||||
|
||||
```
|
||||
allprojects {
|
||||
repositories {
|
||||
...
|
||||
maven { url 'https://jitpack.io' }
|
||||
}
|
||||
}
|
||||
dependencies {
|
||||
implementation 'io.github.wulkanowy:sdk:2.0.7-SNAPSHOT' // lub nowsza wersja, patrz na badge powyżej
|
||||
}
|
||||
```
|
||||
11
docs/docs/index.md
Normal file
11
docs/docs/index.md
Normal file
|
|
@ -0,0 +1,11 @@
|
|||
# Witaj w Kotlin SDK dla VULCAN UONET+
|
||||
|
||||
[](https://search.maven.org/artifact/io.github.wulkanowy/sdk)
|
||||
|
||||
[](https://discord.gg/vccAQBr)
|
||||
|
||||
## Składniki SDK
|
||||
|
||||
- sdk-hebe — używa API "Hebe", którego używa oficjalna aplikacja "Dzienniczek VULCAN"
|
||||
- sdk-scrapper — jak wskazuje nazwa, "scrapuje" stronę www dziennika
|
||||
- sdk — łączy dwie powyższe metody w miarę spójny interfejs
|
||||
103
docs/mkdocs.yml
Normal file
103
docs/mkdocs.yml
Normal file
|
|
@ -0,0 +1,103 @@
|
|||
site_name: VULCAN UONET+ SDK
|
||||
|
||||
# Meta tags (placed in header)
|
||||
site_description:
|
||||
#site_author: Your Name
|
||||
site_url: # https://github.com/wulkanowy/sdk
|
||||
|
||||
# Repository (add link to repository on each page)
|
||||
repo_name: sdk
|
||||
repo_url: https://github.com/wulkanowy/sdk
|
||||
edit_uri: edit/master/docs/docs/
|
||||
|
||||
#Copyright (shown at the footer)
|
||||
copyright: 'Copyright © 2023 Wulkanowy'
|
||||
|
||||
# Meterial theme
|
||||
theme:
|
||||
name: 'material'
|
||||
palette:
|
||||
- media: "(prefers-color-scheme: light)"
|
||||
scheme: default
|
||||
primary: red
|
||||
accent: red
|
||||
toggle:
|
||||
icon: material/brightness-7
|
||||
name: Switch to dark mode
|
||||
- media: "(prefers-color-scheme: dark)"
|
||||
scheme: slate
|
||||
primary: red
|
||||
accent: red
|
||||
toggle:
|
||||
icon: material/brightness-4
|
||||
name: Switch to light mode
|
||||
features:
|
||||
#- navigation.tabs
|
||||
#- navigation.tabs.sticky
|
||||
#- navigation.instant
|
||||
- navigation.tracking
|
||||
- navigation.top
|
||||
|
||||
plugins:
|
||||
- search
|
||||
# Required for variables support (https://github.com/rosscdh/mkdocs-markdownextradata-plugin)
|
||||
# - markdownextradata
|
||||
|
||||
extra:
|
||||
|
||||
# version:
|
||||
# provider: mike
|
||||
|
||||
social:
|
||||
- icon: fontawesome/brands/facebook
|
||||
link: https://facebook.com/wulkanowy
|
||||
- icon: fontawesome/brands/github
|
||||
link: https://github.com/wulkanowy
|
||||
- icon: fontawesome/brands/twitter
|
||||
link: https://twitter.com/wulkanowy
|
||||
#
|
||||
# Google Analytics
|
||||
# analytics:
|
||||
# provider: google
|
||||
# property: UA-XXXXXXXX-X
|
||||
|
||||
markdown_extensions:
|
||||
# Python Markdown
|
||||
- abbr
|
||||
- admonition
|
||||
- attr_list
|
||||
- def_list
|
||||
- footnotes
|
||||
- meta
|
||||
- md_in_html
|
||||
- toc:
|
||||
permalink: true
|
||||
|
||||
# Python Markdown Extensions
|
||||
- pymdownx.arithmatex:
|
||||
generic: true
|
||||
- pymdownx.betterem:
|
||||
smart_enable: all
|
||||
- pymdownx.caret
|
||||
- pymdownx.details
|
||||
- pymdownx.emoji:
|
||||
emoji_index: !!python/name:materialx.emoji.twemoji
|
||||
emoji_generator: !!python/name:materialx.emoji.to_svg
|
||||
- pymdownx.highlight
|
||||
- pymdownx.inlinehilite
|
||||
- pymdownx.keys
|
||||
- pymdownx.mark
|
||||
- pymdownx.smartsymbols
|
||||
- pymdownx.superfences
|
||||
- pymdownx.tabbed:
|
||||
alternate_style: true
|
||||
- pymdownx.tasklist:
|
||||
custom_checkbox: true
|
||||
- pymdownx.tilde
|
||||
|
||||
nav:
|
||||
- Start: index.md
|
||||
- User guide:
|
||||
- Instalacja: guide/installation.md
|
||||
- O projekcie:
|
||||
- Historia wydań: about/history.md
|
||||
Loading…
Reference in a new issue