From ca642a87cd827eb5870088c9c8dc8bf308f2d7f7 Mon Sep 17 00:00:00 2001 From: The-EDev Date: Mon, 30 Nov 2020 23:05:55 +0300 Subject: [PATCH] Updated all URLs for migration and to fix mkdocs --- .travis.yml | 4 ++-- README.md | 14 +++++++------- docs/getting_started/setup.md | 2 +- docs/getting_started/your_first_application.md | 4 ++-- docs/guides/app.md | 4 ++-- docs/guides/json.md | 4 ++-- docs/guides/multipart.md | 2 +- docs/guides/routes.md | 6 +++--- docs/guides/syste.md | 2 ++ docs/guides/templating.md | 2 +- docs/guides/websockets.md | 2 +- docs/index.md | 14 +++++++------- mkdocs.yml | 8 ++++---- 13 files changed, 35 insertions(+), 33 deletions(-) diff --git a/.travis.yml b/.travis.yml index da40b46ca..ff013102d 100644 --- a/.travis.yml +++ b/.travis.yml @@ -21,8 +21,8 @@ env: - secure: "CQRYHWlg/WDu5DBUeDwGo+rPeOofN08DhiLUNlLtZjMWaRyP0Cop1qVaFs8ESOkYiWek2MdpvjZud+7hL+yx2ogvNx4SfHpUMCDKYgcX+YQ9MmYwabvoKq8N6KVXE3lbPp549TonHdDuNCWNKRniNjYtrij5J+IiIiT8/6Txo2p9RWk6YSUTdXJ9YrfuWMtRuF5uo9SHGyujv8pOJKedrwWoSBbHT44jnwfHMVe/C8jgjwlrJ9N3iXOtsG6sj+UTS8vOpL+jpBONEbBfHgSFU57I7IFNdPQbSObpVwG9geOAHT7IQQyQ9hp2AJoFxxVURB5SzqztDDpQ0XIF76vuH9tA/fF2pwDsLRmcLR8JU1TCmQgvnlYD0+Or9S1Dq0tQME5AP+21Hk2zVcGdbgQP7XWix758F0vpOXa4PXw8TmAjP2jKyAMHlzR3icr3+OmKSK3uXMMt2HSMOJQ+JvFxr//DM493i/VGyeY25/zu3A9RstiE+1d82Fi9xKOmMf4smvSkjOgT0b727jqNbNe6CvEKQUmqHabzYRQzUVz6WPVDHBxZP7AiKmZIVQXYnDsVXywStkSoxxY5En6XKpq0GR3bIVtUMORgZPoZi7Jni+/4EckcYH8g9mpsQf9tPRcOZ2WIvt5gqp2MZuwBLBRcbxihuECfBscqdeA0oDU5AZw=" - GH_REPO_NAME: crow - DOXYFILE: $TRAVIS_BUILD_DIR/Doxyfile - - GH_REPO_REF: github.com/mrozigor/crow.git - - THEME_REPO_REF: github.com/mrozigor/darxygen.git + - GH_REPO_REF: github.com/crowcpp/crow.git + - THEME_REPO_REF: github.com/crowcpp/darxygen.git addons: diff --git a/README.md b/README.md index 6581ec9c1..1f94efb61 100644 --- a/README.md +++ b/README.md @@ -2,9 +2,9 @@

A Fast and Easy to use microframework for the web.

-Build Status -Coverage Status -Documentation +Build Status +Coverage Status +Documentation Gitter

@@ -26,10 +26,10 @@ Crow is a C++ microframework for running web services. It uses routing similar t - Uses modern C++ (11/14) ### Still in development - - [HTTP/2 support](https://github.com/mrozigor/crow/issues/8) + - [HTTP/2 support](https://github.com/crowcpp/crow/issues/8) ## Documentation -Available [here](https://mrozigor.github.io/crow). +Available [here](https://crowcpp.github.io/crow). ## Examples @@ -94,10 +94,10 @@ CROW_ROUTE(app, "/add_json") }); ``` -More examples can be found [here](https://github.com/mrozigor/crow/tree/master/examples). +More examples can be found [here](https://github.com/crowcpp/crow/tree/master/examples). ## Setting Up / Building -Available [here](https://mrozigor.github.io/crow/getting_started/setup). +Available [here](https://crowcpp.github.io/crow/getting_started/setup). ### Attributions diff --git a/docs/getting_started/setup.md b/docs/getting_started/setup.md index 6f0a1c879..42b4580e8 100644 --- a/docs/getting_started/setup.md +++ b/docs/getting_started/setup.md @@ -20,7 +20,7 @@ This page explains how to set Crow up for use with your project. Download boost from [here](https://www.boost.org/) and install it ##Downloading -Either run `git clone https://github.com/mrozigor/crow.git` or download `crow_all.h` from the releases section. You can also download a zip of the project on github. +Either run `git clone https://github.com/crowcpp/crow.git` or download `crow_all.h` from the releases section. You can also download a zip of the project on github. ##Includes folder 1. Copy the `/includes` folder to your project's root folder. diff --git a/docs/getting_started/your_first_application.md b/docs/getting_started/your_first_application.md index 1bd00c557..4f81f9953 100644 --- a/docs/getting_started/your_first_application.md +++ b/docs/getting_started/your_first_application.md @@ -12,7 +12,7 @@ int main() } ``` The App (or SimpleApp) class organizes all the different parts of Crow and provides the developer (you) a simple interface to interact with these parts. -For more information, please go [here](/guides/app). +For more information, please go [here](../../guides/app). ##3. Adding routes Once you have your app, the next step is to add routes (or endpoints). You can do so with the `CROW_ROUTE` macro. @@ -21,7 +21,7 @@ CROW_ROUTE(app, "/")([](){ return "Hello world"; }); ``` -For more details on routes, please go [here](/guides/routes). +For more details on routes, please go [here](../../guides/routes). #4. Running the app Once you're happy with how you defined all your routes, you're going to want to instruct Crow to run your app. This is done using the `run()` method. diff --git a/docs/guides/app.md b/docs/guides/app.md index 639051958..83835e892 100644 --- a/docs/guides/app.md +++ b/docs/guides/app.md @@ -25,5 +25,5 @@ app.bindaddr(192.168.1.2) ```

-For more info on middlewares, check out [this page](/guides/middleware).

-For more info on what functions are available to a Crow app, go [here](/reference/classcrow_1_1_crow.html). \ No newline at end of file +For more info on middlewares, check out [this page](../middleware).

+For more info on what functions are available to a Crow app, go [here](../../reference/classcrow_1_1_crow.html). diff --git a/docs/guides/json.md b/docs/guides/json.md index 28392b46e..e7940f054 100644 --- a/docs/guides/json.md +++ b/docs/guides/json.md @@ -24,6 +24,6 @@ The types of values that `wvalue` can take are as follows:
- `Object`: from type `crow::json::wvalue`.
This last type means that `wvalue` can have keys, this is done by simply assigning a value to whatever string key you like, something like `#!cpp wval["key1"] = val1;`. Keep in mind that val1 can be any of the above types.

-A JSON wvalue can be returned directly inside a route handler, this will cause the `content-type` header to automatically be set to `Application/json` and the JSON value will be converted to string and placed in the response body. For more information go to [Routes](/guides/routes).

+A JSON wvalue can be returned directly inside a route handler, this will cause the `content-type` header to automatically be set to `Application/json` and the JSON value will be converted to string and placed in the response body. For more information go to [Routes](../routes).

-For more info on write values go [here](/reference/classcrow_1_1json_1_1wvalue.html). +For more info on write values go [here](../../reference/classcrow_1_1json_1_1wvalue.html). diff --git a/docs/guides/multipart.md b/docs/guides/multipart.md index 645578ae7..61cc47183 100644 --- a/docs/guides/multipart.md +++ b/docs/guides/multipart.md @@ -17,4 +17,4 @@ A message can be created either by defining the headers, boundary, and individua Once a multipart message has been made, the individual parts can be accessed throught `mpmes.parts`, `parts` is an `std::vector`, so accessing the individual parts should be straightforward.
In order to access the individual part's name or filename, something like `#!cpp mpmes.parts[0].headers[0].params["name"]` sould do the trick.

-For more info on Multipart messages, go [here](/reference/namespacecrow_1_1multipart.html) \ No newline at end of file +For more info on Multipart messages, go [here](../../reference/namespacecrow_1_1multipart.html) diff --git a/docs/guides/routes.md b/docs/guides/routes.md index 8fa65c897..c04b53d61 100644 --- a/docs/guides/routes.md +++ b/docs/guides/routes.md @@ -27,7 +27,7 @@ Handlers can also use information from the request by adding it as a parameter ` You can also access the url parameters in the handler using `#!cpp req.url_params.get("param_name");`. If the parameter doesn't exist, `nullptr` is returned.

-For more information on `crow::request` go [here](/reference/structcrow_1_1request.html).

+For more information on `crow::request` go [here](../../reference/structcrow_1_1request.html).

###Response Crow also provides the ability to define a response in the parameters by using `#!cpp ([](const crow::request& req, crow::response& res){...})`.
@@ -37,9 +37,9 @@ Please note that in order to return a response defined as a parameter you'll nee Alternatively, you can define the response in the body and return it (`#!cpp ([](){return crow::response()})`).
-For more information on `crow::response` go [here](/reference/structcrow_1_1response.html).

+For more information on `crow::response` go [here](../../reference/structcrow_1_1response.html).

###return statement A `crow::response` is very strictly tied to a route. If you can have something in a response constructor, you can return it in a handler.

The main return type is `std::string`. although you could also return a `crow::json::wvalue` directly. ***(Support for more data types including third party libraries is coming soon)***

-For more information on the specific constructors for a `crow::response` go [here](/reference/structcrow_1_1response.html). +For more information on the specific constructors for a `crow::response` go [here](../../reference/structcrow_1_1response.html). diff --git a/docs/guides/syste.md b/docs/guides/syste.md index 3dab0f203..e21d0bb4d 100644 --- a/docs/guides/syste.md +++ b/docs/guides/syste.md @@ -1 +1,3 @@ https://www.howtogeek.com/687970/how-to-run-a-linux-program-at-startup-with-systemd/ + +***HELP NEEDED*** diff --git a/docs/guides/templating.md b/docs/guides/templating.md index fd6e623dc..5849896d5 100644 --- a/docs/guides/templating.md +++ b/docs/guides/templating.md @@ -15,7 +15,7 @@ The HTML page (including the mustache tags). It is usually loaded into `crow::mu For more information on how to formulate a template, see [this mustache manual](http://mustache.github.io/mustache.5.html). ###Context -A JSON object containing the tags as keys and their values. `crow::mustache::context` is actually a [crow::json::wvalue](/guides/json#wvalue). +A JSON object containing the tags as keys and their values. `crow::mustache::context` is actually a [crow::json::wvalue](../json#wvalue). ##Returning a template To return a mustache template, you need to load a page using `#!cpp auto page = crow::mustache::load("path/to/template.html");`, keep in mind that the path is relative to the templates directory.
diff --git a/docs/guides/websockets.md b/docs/guides/websockets.md index 47d66c18e..e0d25dac9 100644 --- a/docs/guides/websockets.md +++ b/docs/guides/websockets.md @@ -28,4 +28,4 @@ CROW_ROUTE(app, "/ws") }); ```

-For more info go [here](/reference/classcrow_1_1_web_socket_rule.html). \ No newline at end of file +For more info go [here](../../reference/classcrow_1_1_web_socket_rule.html). diff --git a/docs/index.md b/docs/index.md index 6327a2d7c..edc447943 100644 --- a/docs/index.md +++ b/docs/index.md @@ -3,9 +3,9 @@

A Fast and Easy to use microframework for the web.

-Build Status -Coverage Status -Documentation +Build Status +Coverage Status +Documentation Gitter

@@ -27,10 +27,10 @@ Crow is a C++ microframework for running web services. It uses routing similar t - Uses modern C++ (11/14) ### Still in development - - [HTTP/2 support](https://github.com/mrozigor/crow/issues/8) + - [HTTP/2 support](https://github.com/crowcpp/crow/issues/8) ## Documentation -Available [here](https://mrozigor.github.io/crow). +Available [here](https://crowcpp.github.io/crow). ## Examples @@ -95,7 +95,7 @@ CROW_ROUTE(app, "/add_json") }); ``` -More examples can be found [here](https://github.com/mrozigor/crow/tree/master/examples). +More examples can be found [here](https://github.com/crowcpp/crow/tree/master/examples). ## Setting Up / Building -Available [here](https://mrozigor.github.io/crow/getting_started/setup). +Available [here](https://crowcpp.github.io/crow/getting_started/setup). diff --git a/mkdocs.yml b/mkdocs.yml index 370b9619b..0954efad0 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,9 +1,9 @@ site_name: Crow # Repository -repo_name: mrozigor/crow -repo_url: https://github.com/mrozigor/crow -site_url: https://mrozigor.github.io/crow +repo_name: crowcpp/crow +repo_url: https://github.com/crowcpp/crow +site_url: https://crowcpp.github.io/crow edit_uri: "" theme: @@ -49,7 +49,7 @@ nav: extra: social: - icon: fontawesome/brands/github - link: https://github.com/mrozigor/crow + link: https://github.com/crowcpp/crow - icon: fontawesome/brands/gitter link: https://gitter.im/crowfork/community