diff --git a/doc/README.md b/doc/README.md index 382b4b0c..d1fb5318 100644 --- a/doc/README.md +++ b/doc/README.md @@ -10,6 +10,7 @@ * Extendable * Modular * [Fast](performance.md) +* [Frontend routing](./frontend/README.md) Modules: @@ -19,8 +20,9 @@ Modules: * `reitit-schema` [Schema](https://github.com/plumatic/schema) coercion * `reitit-swagger` [Swagger2](https://swagger.io/) apidocs * `reitit-swagger-ui` Integrated [Swagger UI](https://github.com/swagger-api/swagger-ui). +* `reitit-frontend` Tools for frontend routing. -To use Reitit, add the following dependecy to your project: +To use Reitit, add the following dependency to your project: ```clj [metosin/reitit "0.1.4-SNAPSHOT"] @@ -35,6 +37,7 @@ Optionally, the parts can be required separately: [metosin/reitit-schema "0.1.4-SNAPSHOT"] [metosin/reitit-swagger "0.1.4-SNAPSHOT"] [metosin/reitit-swagger-ui "0.1.4-SNAPSHOT"] +[metosin/frontend "0.1.4-SNAPSHOT"] ``` For discussions, there is a [#reitit](https://clojurians.slack.com/messages/reitit/) channel in [Clojurians slack](http://clojurians.net/). diff --git a/doc/cljdoc.edn b/doc/cljdoc.edn index 819e60a8..ffc68d25 100644 --- a/doc/cljdoc.edn +++ b/doc/cljdoc.edn @@ -45,6 +45,11 @@ {:file "doc/ring/route_data_validation.md"}] ["Compiling Middleware" {:file "doc/ring/compiling_middleware.md"}] ["Swagger Support" {:file "doc/ring/swagger.md"}]] + ["Frontend" + {:file "doc/frontend/README.md"} + ["Basics" {:file "doc/frontend/basics.md"}] + ["Browser integration" {:file "doc/frontend/browser.md"}] + ["Controllers" {:file "doc/frontend/controllers/.md"}]] ["Performance" {:file "doc/performance.md"}] ["Interceptors (WIP)" {:file "doc/interceptors.md"}] ["Development Instructions" {:file "doc/development.md"}] diff --git a/doc/frontend/README.md b/doc/frontend/README.md new file mode 100644 index 00000000..65b78197 --- /dev/null +++ b/doc/frontend/README.md @@ -0,0 +1,5 @@ +# Frontend + +* [Basics](basics.md) +* [Browser integration](browser.md) +* [Controllers](controllers.md) diff --git a/doc/frontend/basics.md b/doc/frontend/basics.md new file mode 100644 index 00000000..b0d632fb --- /dev/null +++ b/doc/frontend/basics.md @@ -0,0 +1,3 @@ +# Frontend basics + +TODO diff --git a/doc/frontend/browser.md b/doc/frontend/browser.md new file mode 100644 index 00000000..a7a8c613 --- /dev/null +++ b/doc/frontend/browser.md @@ -0,0 +1,3 @@ +# Frontend browser integration + +TODO diff --git a/doc/frontend/controllers.md b/doc/frontend/controllers.md new file mode 100644 index 00000000..11f9f263 --- /dev/null +++ b/doc/frontend/controllers.md @@ -0,0 +1,3 @@ +# Controllers + +TODO