diff --git a/docs/_config.yml b/docs/_config.yml new file mode 100644 index 0000000..7dbcc9c --- /dev/null +++ b/docs/_config.yml @@ -0,0 +1 @@ +theme: midnight \ No newline at end of file diff --git a/docs/basics.md b/docs/basics.md index 433647a..8699b9c 100644 --- a/docs/basics.md +++ b/docs/basics.md @@ -192,4 +192,6 @@ If you need to access the raw pointer of `libuv` you can use `app.get_native_han ## Preserve data for use after await HttpRequest object being stack-allocated and only valid in one single callback invocation so only valid in the first "segment" before the first await. -If you just want to preserve headers, url, method, cookies and query string you can use `req.preserve()` to copy all data and keep it in the request object, but will be some performance penality. \ No newline at end of file +If you just want to preserve headers, url, method, cookies and query string you can use `req.preserve()` to copy all data and keep it in the request object, but will be some performance penality. + +### Next [Upload and Post](upload-post.md) \ No newline at end of file diff --git a/docs/corking.md b/docs/corking.md index 32ffbb1..5c77bc5 100644 --- a/docs/corking.md +++ b/docs/corking.md @@ -36,4 +36,6 @@ async def home(res, req): ``` > You cannot use async inside cork but, you can cork only when you need to send the response after all the async happens -For convinience we have `res.cork_end()`, `ws.cork_send()` that will cork and call end for you, and also `res.render()` that will always response using `res.cork_end()` to send your HTML / Data \ No newline at end of file +For convinience we have `res.cork_end()`, `ws.cork_send()` that will cork and call end for you, and also `res.render()` that will always response using `res.cork_end()` to send your HTML / Data + +### Next [Routes](routes.md) \ No newline at end of file diff --git a/docs/getting-started.md b/docs/getting-started.md index fd1bee8..4d653d2 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -58,3 +58,5 @@ app.run() If you just wanna to see some more examples you can go to our [examples folder](https://github.com/cirospaciari/socketify.py/tree/main/examples) for more than 25 quick examples. + +### Next [Corking Concept](corking.md) \ No newline at end of file diff --git a/docs/instalation.md b/docs/installation.md similarity index 94% rename from docs/instalation.md rename to docs/installation.md index e31545d..f7c475c 100644 --- a/docs/instalation.md +++ b/docs/installation.md @@ -31,3 +31,6 @@ Linux ```bash apt install libuv1 zlib1g ``` + + +### Next [Getting Started](getting-started.md) \ No newline at end of file diff --git a/docs/middlewares.md b/docs/middlewares.md index 3303f67..740ca83 100644 --- a/docs/middlewares.md +++ b/docs/middlewares.md @@ -64,4 +64,6 @@ app.listen( ) app.run() -``` \ No newline at end of file +``` + +### Next [Basics](basics.md) \ No newline at end of file diff --git a/docs/routes.md b/docs/routes.md index a8ebb1b..a19ddeb 100644 --- a/docs/routes.md +++ b/docs/routes.md @@ -134,4 +134,6 @@ app.domain("*.google.*").get("/*", google) #you can also remove an server name app.remove_server_name("*.google.*") -``` \ No newline at end of file +``` + +### Next [Middlewares](middlewares.md) \ No newline at end of file diff --git a/docs/ssl.md b/docs/ssl.md index 7808e07..f8d397c 100644 --- a/docs/ssl.md +++ b/docs/ssl.md @@ -1 +1,3 @@ -Support is already there, docs Comming soon... \ No newline at end of file +Support is already there, docs Comming soon... + +### Next [API Reference](api.md) \ No newline at end of file diff --git a/docs/static-files.md b/docs/static-files.md index 637fc87..f4934e5 100644 --- a/docs/static-files.md +++ b/docs/static-files.md @@ -27,4 +27,6 @@ app.listen( ) app.run() -``` \ No newline at end of file +``` + +### Next [Templates](templates.md) \ No newline at end of file diff --git a/docs/streaming-data.md b/docs/streaming-data.md index ffebba9..105ec4d 100644 --- a/docs/streaming-data.md +++ b/docs/streaming-data.md @@ -61,4 +61,6 @@ def send_chunk(self, buffer, total_size): self._lastChunkOffset = self.get_write_offset() return self._chunkFuture -``` \ No newline at end of file +``` + +### Next [Send File and Static Files](static-files.md) \ No newline at end of file diff --git a/docs/templates.md b/docs/templates.md index 043abcb..d1563ea 100644 --- a/docs/templates.md +++ b/docs/templates.md @@ -71,4 +71,6 @@ app.listen( ) app.run() -``` \ No newline at end of file +``` + +### Next [GraphiQL](graphiQL.md) \ No newline at end of file diff --git a/docs/upload-post.md b/docs/upload-post.md index 3dc5785..e16ed2a 100644 --- a/docs/upload-post.md +++ b/docs/upload-post.md @@ -89,4 +89,6 @@ async def upload_multiple(res, req): # We respond when we are done res.cork_end("Thanks for the data!") -``` \ No newline at end of file +``` + +### Next [Streaming Data](streaming-data.md) \ No newline at end of file diff --git a/docs/websockets-backpressure.md b/docs/websockets-backpressure.md index 6e439e3..af7e1d6 100644 --- a/docs/websockets-backpressure.md +++ b/docs/websockets-backpressure.md @@ -48,4 +48,6 @@ Compressing using shared means that every WebSocket message is an isolated compr You probably want shared compressor if dealing with larger JSON messages, or 4kb dedicated compressor if dealing with smaller JSON messages and if doing binary messaging you probably want to disable it completely. -idle_timeout is roughly the amount of seconds that may pass between messages. Being idle for more than this, and the connection is severed. This means you should make your clients send small ping messages every now and then, to keep the connection alive. The server will automatically send pings in case it needs to. \ No newline at end of file +idle_timeout is roughly the amount of seconds that may pass between messages. Being idle for more than this, and the connection is severed. This means you should make your clients send small ping messages every now and then, to keep the connection alive. The server will automatically send pings in case it needs to. + +### Next [SSL](ssl.md) \ No newline at end of file