diff --git a/book.json b/book.json index aa1f4270..4f7a487a 100644 --- a/book.json +++ b/book.json @@ -1,6 +1,6 @@ { "root": "doc", - "plugins": ["editlink", "github", "highlight"], + "plugins": ["hints", "editlink", "github", "highlight"], "pluginsConfig": { "editlink": { "base": "https://github.com/metosin/reitit/tree/master/doc", diff --git a/doc/SUMMARY.md b/doc/SUMMARY.md index 65ae642e..e6b72f6c 100644 --- a/doc/SUMMARY.md +++ b/doc/SUMMARY.md @@ -1,46 +1,63 @@ # Summary +## Introduction + * [Introduction](README.md) -* [Basics](basics/README.md) - * [Route Syntax](basics/route_syntax.md) - * [Router](basics/router.md) - * [Path-based Routing](basics/path_based_routing.md) - * [Name-based Routing](basics/name_based_routing.md) - * [Route Data](basics/route_data.md) - * [Route Data Validation](basics/route_data_validation.md) - * [Route Conflicts](basics/route_conflicts.md) -* [Coercion](coercion/README.md) - * [Coercion Explained](coercion/coercion.md) - * [Plumatic Schema](coercion/schema_coercion.md) - * [Clojure.spec](coercion/clojure_spec_coercion.md) - * [Data-specs](coercion/data_spec_coercion.md) -* [Ring](ring/README.md) - * [Ring-router](ring/ring.md) - * [Reverse-routing](ring/reverse_routing.md) - * [Default handler](ring/default_handler.md) - * [Static Resources](ring/static.md) - * [Dynamic Extensions](ring/dynamic_extensions.md) - * [Data-driven Middleware](ring/data_driven_middleware.md) - * [Transforming Middleware Chain](ring/transforming_middleware_chain.md) - * [Middleware Registry](ring/middleware_registry.md) - * [Default Middleware](ring/default_middleware.md) - * [Pluggable Coercion](ring/coercion.md) - * [Route Data Validation](ring/route_data_validation.md) - * [Compiling Middleware](ring/compiling_middleware.md) - * [Swagger Support](ring/swagger.md) -* [Advanced](advanced/README.md) - * [Configuring Routers](advanced/configuring_routers.md) - * [Composing Routers](advanced/composing_routers.md) - * [Different Routers](advanced/different_routers.md) - * [Route Validation](advanced/route_validation.md) - * [Dev Workflow](advanced/dev_workflow.md) -* [Patterns](patterns/README.md) - * [Shared Routes](patterns/shared_routes.md) -* [Frontend](frontend/README.md) - * [Basics](frontend/basics.md) - * [Browser integration](frontend/browser.md) - * [Controllers (WIP)](frontend/controllers.md) + +## Basics + +* [Route Syntax](basics/route_syntax.md) +* [Router](basics/router.md) +* [Path-based Routing](basics/path_based_routing.md) +* [Name-based Routing](basics/name_based_routing.md) +* [Route Data](basics/route_data.md) +* [Route Data Validation](basics/route_data_validation.md) +* [Route Conflicts](basics/route_conflicts.md) + +## Coercion + +* [Coercion Explained](coercion/coercion.md) +* [Plumatic Schema](coercion/schema_coercion.md) +* [Clojure.spec](coercion/clojure_spec_coercion.md) +* [Data-specs](coercion/data_spec_coercion.md) + +## Ring + +* [Ring-router](ring/ring.md) +* [Reverse-routing](ring/reverse_routing.md) +* [Default handler](ring/default_handler.md) +* [Static Resources](ring/static.md) +* [Dynamic Extensions](ring/dynamic_extensions.md) +* [Data-driven Middleware](ring/data_driven_middleware.md) +* [Transforming Middleware Chain](ring/transforming_middleware_chain.md) +* [Middleware Registry](ring/middleware_registry.md) +* [Default Middleware](ring/default_middleware.md) +* [Pluggable Coercion](ring/coercion.md) +* [Route Data Validation](ring/route_data_validation.md) +* [Compiling Middleware](ring/compiling_middleware.md) +* [Swagger Support](ring/swagger.md) + +## Frontend + +* [Basics](frontend/basics.md) +* [Browser integration](frontend/browser.md) +* [Controllers (WIP)](frontend/controllers.md) + +## HTTP + +* [Interceptors](http/interceptors.md) + +## Advanced + +* [Configuring Routers](advanced/configuring_routers.md) +* [Composing Routers](advanced/composing_routers.md) +* [Different Routers](advanced/different_routers.md) +* [Route Validation](advanced/route_validation.md) +* [Dev Workflow](advanced/dev_workflow.md) +* [Shared Routes](advanced/shared_routes.md) + +## Misc + * [Performance](performance.md) -* [Interceptors (WIP)](interceptors.md) * [Development Instructions](development.md) * [FAQ](faq.md) diff --git a/doc/advanced/README.md b/doc/advanced/README.md deleted file mode 100644 index 6069fb9f..00000000 --- a/doc/advanced/README.md +++ /dev/null @@ -1,6 +0,0 @@ -# Advanced - -* [Configuring Routers](configuring_routers.md) -* [Composing Routers](composing_routers.md) -* [Different Routers](different_routers.md) -* [Route Validation](route_validation.md) diff --git a/doc/patterns/shared_routes.md b/doc/advanced/shared_routes.md similarity index 100% rename from doc/patterns/shared_routes.md rename to doc/advanced/shared_routes.md diff --git a/doc/basics/README.md b/doc/basics/README.md deleted file mode 100644 index 77fcb3d7..00000000 --- a/doc/basics/README.md +++ /dev/null @@ -1,9 +0,0 @@ -# Basics - -* [Route Syntax](route_syntax.md) -* [Router](router.md) -* [Path-based Routing](path_based_routing.md) -* [Name-based Routing](name_based_routing.md) -* [Route Data](route_data.md) -* [Route Data Validation](route_data_validation.md) -* [Route Conflicts](route_conflicts.md) diff --git a/doc/cljdoc.edn b/doc/cljdoc.edn index 56a81643..77dcdc49 100644 --- a/doc/cljdoc.edn +++ b/doc/cljdoc.edn @@ -9,56 +9,47 @@ :cljdoc.doc/tree [["Introduction" {:file "doc/README.md"}] ["Basics" - {:file "doc/basics/README.md"} ["Route Syntax" {:file "doc/basics/route_syntax.md"}] ["Router" {:file "doc/basics/router.md"}] ["Path-based Routing" {:file "doc/basics/path_based_routing.md"}] ["Name-based Routing" {:file "doc/basics/name_based_routing.md"}] ["Route Data" {:file "doc/basics/route_data.md"}] - ["Route Data Validation" - {:file "doc/basics/route_data_validation.md"}] + ["Route Data Validation" {:file "doc/basics/route_data_validation.md"}] ["Route Conflicts" {:file "doc/basics/route_conflicts.md"}]] ["Coercion" - {:file "doc/coercion/README.md"} ["Coercion Explained" {:file "doc/coercion/coercion.md"}] ["Plumatic Schema" {:file "doc/coercion/schema_coercion.md"}] ["Clojure.spec" {:file "doc/coercion/clojure_spec_coercion.md"}] ["Data-specs" {:file "doc/coercion/data_spec_coercion.md"}]] ["Ring" - {:file "doc/ring/README.md"} ["Ring-router" {:file "doc/ring/ring.md"}] ["Reverse-routing" {:file "doc/ring/reverse_routing.md"}] ["Default handler" {:file "doc/ring/default_handler.md"}] ["Static Resources" {:file "doc/ring/static.md"}] ["Dynamic Extensions" {:file "doc/ring/dynamic_extensions.md"}] - ["Data-driven Middleware" - {:file "doc/ring/data_driven_middleware.md"}] - ["Transforming Middleware Chain" - {:file "doc/ring/transforming_middleware_chain.md"}] + ["Data-driven Middleware" {:file "doc/ring/data_driven_middleware.md"}] + ["Transforming Middleware Chain" {:file "doc/ring/transforming_middleware_chain.md"}] ["Middleware Registry" {:file "doc/ring/middleware_registry.md"}] ["Default Middleware" {:file "doc/ring/default_middleware.md"}] ["Pluggable Coercion" {:file "doc/ring/coercion.md"}] - ["Route Data Validation" - {:file "doc/ring/route_data_validation.md"}] + ["Route Data Validation" {:file "doc/ring/route_data_validation.md"}] ["Compiling Middleware" {:file "doc/ring/compiling_middleware.md"}] ["Swagger Support" {:file "doc/ring/swagger.md"}]] - ["Advanced" - {:file "doc/advanced/README.md"} - ["Configuring Routers" - {:file "doc/advanced/configuring_routers.md"}] - ["Composing Routers" {:file "doc/advanced/composing_routers.md"}] - ["Different Routers" {:file "doc/advanced/different_routers.md"}] - ["Route Validation" {:file "doc/advanced/route_validation.md"}] - ["Dev Workflow" {:file "doc/advanced/dev_workflow.md"}]] - ["Patterns" - {:file "doc/patterns/README.md"} - ["Shared Routes" {:file "doc/patterns/shared_routes.md"}]] ["Frontend" - {:file "doc/frontend/README.md"} ["Basics" {:file "doc/frontend/basics.md"}] ["Browser integration" {:file "doc/frontend/browser.md"}] ["Controllers (WIP)" {:file "doc/frontend/controllers.md"}]] - ["Performance" {:file "doc/performance.md"}] - ["Interceptors (WIP)" {:file "doc/interceptors.md"}] - ["Development Instructions" {:file "doc/development.md"}] - ["FAQ" {:file "doc/faq.md"}]]} + ["HTTP" + ["Interceptors" {:file "doc/http/interceptors.md"}]] + ["Advanced" + ["Configuring Routers" {:file "doc/advanced/configuring_routers.md"}] + ["Composing Routers" {:file "doc/advanced/composing_routers.md"}] + ["Different Routers" {:file "doc/advanced/different_routers.md"}] + ["Route Validation" {:file "doc/advanced/route_validation.md"}] + ["Dev Workflow" {:file "doc/advanced/dev_workflow.md"}] + ["Shared Routes" {:file "doc/patterns/shared_routes.md"}]] + ["Misc" + ["Performance" {:file "doc/performance.md"}] + ["Interceptors (WIP)" {:file "doc/interceptors.md"}] + ["Development Instructions" {:file "doc/development.md"}] + ["FAQ" {:file "doc/faq.md"}]]]} diff --git a/doc/coercion/README.md b/doc/coercion/README.md deleted file mode 100644 index 2cc3d479..00000000 --- a/doc/coercion/README.md +++ /dev/null @@ -1,6 +0,0 @@ -# Coercion - -* [Coercion Explained](coercion.md) -* [Plumatic Schema](schema_coercion.md) -* [Clojure.spec](clojure_spec_coercion.md) -* [Data-specs](data_spec_coercion.md) diff --git a/doc/frontend/README.md b/doc/frontend/README.md deleted file mode 100644 index e1270493..00000000 --- a/doc/frontend/README.md +++ /dev/null @@ -1,5 +0,0 @@ -# Frontend - -* [Basics](basics.md) -* [Browser integration](browser.md) -* [Controllers (WIP)](controllers.md) diff --git a/doc/interceptors.md b/doc/http/interceptors.md similarity index 100% rename from doc/interceptors.md rename to doc/http/interceptors.md diff --git a/doc/patterns/README.md b/doc/patterns/README.md deleted file mode 100644 index 134c53c1..00000000 --- a/doc/patterns/README.md +++ /dev/null @@ -1,3 +0,0 @@ -# Patterns - -* [Shared Routes](shared_routes.md) diff --git a/doc/ring/README.md b/doc/ring/README.md deleted file mode 100644 index 814a92b6..00000000 --- a/doc/ring/README.md +++ /dev/null @@ -1,15 +0,0 @@ -# Ring - -* [Ring-router](ring.md) -* [Reverse-routing](reverse_routing.md) -* [Default handler](default_handler.md) -* [Static Resources](static.md) -* [Dynamic Extensions](dynamic_extensions.md) -* [Data-driven Middleware](data_driven_middleware.md) -* [Transforming Middleware Chain](transforming_middleware_chain.md) -* [Middleware Registry](middleware_registry.md) -* [Default Middleware](default_middleware.md) -* [Pluggable Coercion](coercion.md) -* [Route Data Validation](route_data_validation.md) -* [Compiling Middleware](compiling_middleware.md) -* [Swagger Support](swagger.md)