diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..888e147 --- /dev/null +++ b/docs/index.md @@ -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. diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..717e77f --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,3 @@ +site_name: txtdot +theme: + name: material diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..9a8a4ca --- /dev/null +++ b/requirements.txt @@ -0,0 +1,2 @@ +mkdocs +mkdocs-material