txtdot/documentation
2
0
Fork 0
mirror of https://github.com/TxtDot/documentation.git synced 2024-10-16 11:48:06 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions

Completed "how it works" paragraph

Browse source
This commit is contained in:
DarkCat09 2023-08-30 10:16:44 +04:00
parent e6d89733c4
commit 10ad2a05c8
Signed by: DarkCat09
GPG key ID: 0A26CD5B3345D6E3
1 changed files with 5 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
docs/index.md
View file

@ -29,6 +29,8 @@ For now, engines are functions taking a URL as a parameter,
returning an object that contains extracted HTML and plain text, page title and language. returning an object that contains extracted HTML and plain text, page title and language.
The object is rendered with ejs template (or, in `/api/parse`, just sent as JSON). The object is rendered with ejs template (or, in `/api/parse`, just sent as JSON).
If a `?engine=` parameter wasn't passed, txtdot checks If an `?engine=` parameter wasn't passed, but txtdot found
if the requested domain is assigned to a specific engine, that a specific engine is assigned to the requested domain,
for example, "stackoverflow.com" -> "stackoverflow". for example, `"stackoverflow.com": stackoverflow`,
it uses that engine to process the URL.
Otherwise, the page is parsed with the engine assigned to `*` (it's Readability).