MkDocs, main page

This commit is contained in:
DarkCat09 2023-08-29 19:52:15 +04:00
parent 024180a372
commit cc99f67428
Signed by: DarkCat09
GPG key ID: 0A26CD5B3345D6E3
3 changed files with 16 additions and 0 deletions

11
docs/index.md Normal file
View file

@ -0,0 +1,11 @@
# Getting Started
## What is this?
*txtdot* is a proxy that requests the page by the given URL,
extracts only useful data (text, links, pictures, tables, etc.)
and returns it as an HTML page with a minimalistic design
optimized for reading text.
*txtdot* increases the loading speed and reducing client's bandwidth usage
since no unnecessary code and no scripts are transfered.

3
mkdocs.yml Normal file
View file

@ -0,0 +1,3 @@
site_name: txtdot
theme:
name: material

2
requirements.txt Normal file
View file

@ -0,0 +1,2 @@
mkdocs
mkdocs-material