Crow/docs/guides/static.md

**Introduced in: `v0.2`**<br><br>
A static file is any file that resides in the server's storage.

Crow supports returning Static files as responses in 2 ways.

## Implicit
Crow implicitly returns any static files placed in a `static` directory and any subdirectories, as long as the user calls the endpoint `/static/path/to/file`.<br><br>
The static folder or endpoint can be changed by defining the macros `CROW_STATIC_DIRECTORY "alternative_directory/"` and `CROW_STATIC_ENDPOINT "/alternative_endpoint/<path>"`.<br>
static directory changes the directory in the server's filesystem, while the endpoint changes the URL that the client needs to access.

## Explicit
You can directly return a static file by using the `crow::response` method `#!cpp response.set_static_file_info("path/to/file");`. The path is relative to the executable unless preceded by `/`, then it is an absolute path.<br>
Please keep in mind that using the `set_static_file_info` method does invalidate any data already in your response body.<br><br>

**Note**: Crow sets the `content-type` header automatically based on the file's extension, if an extension is unavailable or undefined,  Crow uses `text/plain`, if you'd like to explicitly set a `content-type`, use `#!cpp response.set_header("content-type", "mime/type");` **AFTER** calling `set_static_file_info`.
Made several changes to docs - Added landing page - Changed theme completely - Added donate button - Added social media picture and description (OpenGraph) - Added version tag to any feature introduced after v0.1 2021-08-13 00:49:34 +00:00			Introduced in: `v0.2`<br><br>
Changed documentation. a lot. Added mkdocs documentation. Altered doxygen generation (doxyfile and shell script) to work with mkdocs. Removed the whole html folder thing for docs, now the files reside in the root gh-pages branch. New readme. 2020-11-28 14:28:47 +00:00			`A static file is any file that resides in the server's storage.`

			`Crow supports returning Static files as responses in 2 ways.`

multiple docs changes: Added meta tags for homepage Added meta description generator Removed usages of <h1> (mkdocs-material doesn't reconize more than 1) added space after # (markdown proper syntax) removed pip3 command from pull request CI 2021-11-06 08:54:29 +00:00			`## Implicit`
Changed documentation. a lot. Added mkdocs documentation. Altered doxygen generation (doxyfile and shell script) to work with mkdocs. Removed the whole html folder thing for docs, now the files reside in the root gh-pages branch. New readme. 2020-11-28 14:28:47 +00:00			Crow implicitly returns any static files placed in a `static` directory and any subdirectories, as long as the user calls the endpoint `/static/path/to/file`.<br><br>
fixed typos and added missing parts 2020-11-28 19:48:09 +00:00			The static folder or endpoint can be changed by defining the macros `CROW_STATIC_DIRECTORY "alternative_directory/"` and `CROW_STATIC_ENDPOINT "/alternative_endpoint/<path>"`.<br>
Changed documentation. a lot. Added mkdocs documentation. Altered doxygen generation (doxyfile and shell script) to work with mkdocs. Removed the whole html folder thing for docs, now the files reside in the root gh-pages branch. New readme. 2020-11-28 14:28:47 +00:00			`static directory changes the directory in the server's filesystem, while the endpoint changes the URL that the client needs to access.`

multiple docs changes: Added meta tags for homepage Added meta description generator Removed usages of <h1> (mkdocs-material doesn't reconize more than 1) added space after # (markdown proper syntax) removed pip3 command from pull request CI 2021-11-06 08:54:29 +00:00			`## Explicit`
Changed documentation. a lot. Added mkdocs documentation. Altered doxygen generation (doxyfile and shell script) to work with mkdocs. Removed the whole html folder thing for docs, now the files reside in the root gh-pages branch. New readme. 2020-11-28 14:28:47 +00:00			You can directly return a static file by using the `crow::response` method `#!cpp response.set_static_file_info("path/to/file");`. The path is relative to the executable unless preceded by `/`, then it is an absolute path.<br>
			Please keep in mind that using the `set_static_file_info` method does invalidate any data already in your response body.<br><br>

fixed typos and added missing parts 2020-11-28 19:48:09 +00:00			Note: Crow sets the `content-type` header automatically based on the file's extension, if an extension is unavailable or undefined, Crow uses `text/plain`, if you'd like to explicitly set a `content-type`, use `#!cpp response.set_header("content-type", "mime/type");` AFTER calling `set_static_file_info`.