mirror of
https://github.com/TxtDot/documentation.git
synced 2024-11-23 13:26:21 +03:00
MkDocs, main page
This commit is contained in:
parent
024180a372
commit
cc99f67428
3 changed files with 16 additions and 0 deletions
11
docs/index.md
Normal file
11
docs/index.md
Normal 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
3
mkdocs.yml
Normal file
|
@ -0,0 +1,3 @@
|
||||||
|
site_name: txtdot
|
||||||
|
theme:
|
||||||
|
name: material
|
2
requirements.txt
Normal file
2
requirements.txt
Normal file
|
@ -0,0 +1,2 @@
|
||||||
|
mkdocs
|
||||||
|
mkdocs-material
|
Loading…
Add table
Reference in a new issue