luciano/reitit
1
0
Fork 0
mirror of https://github.com/metosin/reitit.git synced 2025-12-16 16:01:11 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

initial rework

Browse source
This commit is contained in:
Tommi Reiman 2018-09-02 19:23:18 +03:00
parent 2c51f051de
commit c487b27288
11 changed files with 76 additions and 112 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
book.json
View file

@ -1,6 +1,6 @@
{ {
"root": "doc", "root": "doc",
"plugins": ["editlink", "github", "highlight"], "plugins": ["hints", "editlink", "github", "highlight"],
"pluginsConfig": { "pluginsConfig": {
"editlink": { "editlink": {
"base": "https://github.com/metosin/reitit/tree/master/doc", "base": "https://github.com/metosin/reitit/tree/master/doc",

97
doc/SUMMARY.md
View file

@ -1,46 +1,63 @@
# Summary # Summary
## Introduction
* [Introduction](README.md) * [Introduction](README.md)
* [Basics](basics/README.md)
* [Route Syntax](basics/route_syntax.md) ## Basics
* [Router](basics/router.md)
* [Path-based Routing](basics/path_based_routing.md) * [Route Syntax](basics/route_syntax.md)
* [Name-based Routing](basics/name_based_routing.md) * [Router](basics/router.md)
* [Route Data](basics/route_data.md) * [Path-based Routing](basics/path_based_routing.md)
* [Route Data Validation](basics/route_data_validation.md) * [Name-based Routing](basics/name_based_routing.md)
* [Route Conflicts](basics/route_conflicts.md) * [Route Data](basics/route_data.md)
* [Coercion](coercion/README.md) * [Route Data Validation](basics/route_data_validation.md)
* [Coercion Explained](coercion/coercion.md) * [Route Conflicts](basics/route_conflicts.md)
* [Plumatic Schema](coercion/schema_coercion.md)
* [Clojure.spec](coercion/clojure_spec_coercion.md) ## Coercion
* [Data-specs](coercion/data_spec_coercion.md)
* [Ring](ring/README.md) * [Coercion Explained](coercion/coercion.md)
* [Ring-router](ring/ring.md) * [Plumatic Schema](coercion/schema_coercion.md)
* [Reverse-routing](ring/reverse_routing.md) * [Clojure.spec](coercion/clojure_spec_coercion.md)
* [Default handler](ring/default_handler.md) * [Data-specs](coercion/data_spec_coercion.md)
* [Static Resources](ring/static.md)
* [Dynamic Extensions](ring/dynamic_extensions.md) ## Ring
* [Data-driven Middleware](ring/data_driven_middleware.md)
* [Transforming Middleware Chain](ring/transforming_middleware_chain.md) * [Ring-router](ring/ring.md)
* [Middleware Registry](ring/middleware_registry.md) * [Reverse-routing](ring/reverse_routing.md)
* [Default Middleware](ring/default_middleware.md) * [Default handler](ring/default_handler.md)
* [Pluggable Coercion](ring/coercion.md) * [Static Resources](ring/static.md)
* [Route Data Validation](ring/route_data_validation.md) * [Dynamic Extensions](ring/dynamic_extensions.md)
* [Compiling Middleware](ring/compiling_middleware.md) * [Data-driven Middleware](ring/data_driven_middleware.md)
* [Swagger Support](ring/swagger.md) * [Transforming Middleware Chain](ring/transforming_middleware_chain.md)
* [Advanced](advanced/README.md) * [Middleware Registry](ring/middleware_registry.md)
* [Configuring Routers](advanced/configuring_routers.md) * [Default Middleware](ring/default_middleware.md)
* [Composing Routers](advanced/composing_routers.md) * [Pluggable Coercion](ring/coercion.md)
* [Different Routers](advanced/different_routers.md) * [Route Data Validation](ring/route_data_validation.md)
* [Route Validation](advanced/route_validation.md) * [Compiling Middleware](ring/compiling_middleware.md)
* [Dev Workflow](advanced/dev_workflow.md) * [Swagger Support](ring/swagger.md)
* [Patterns](patterns/README.md)
* [Shared Routes](patterns/shared_routes.md) ## Frontend
* [Frontend](frontend/README.md)
* [Basics](frontend/basics.md) * [Basics](frontend/basics.md)
* [Browser integration](frontend/browser.md) * [Browser integration](frontend/browser.md)
* [Controllers (WIP)](frontend/controllers.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) * [Performance](performance.md)
* [Interceptors (WIP)](interceptors.md)
* [Development Instructions](development.md) * [Development Instructions](development.md)
* [FAQ](faq.md) * [FAQ](faq.md)

6
doc/advanced/README.md
View file

@ -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)

0
doc/patterns/shared_routes.md → doc/advanced/shared_routes.md
View file

9
doc/basics/README.md
View file

@ -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)

45
doc/cljdoc.edn
View file

@ -9,56 +9,47 @@
:cljdoc.doc/tree :cljdoc.doc/tree
[["Introduction" {:file "doc/README.md"}] [["Introduction" {:file "doc/README.md"}]
["Basics" ["Basics"
{:file "doc/basics/README.md"}
["Route Syntax" {:file "doc/basics/route_syntax.md"}] ["Route Syntax" {:file "doc/basics/route_syntax.md"}]
["Router" {:file "doc/basics/router.md"}] ["Router" {:file "doc/basics/router.md"}]
["Path-based Routing" {:file "doc/basics/path_based_routing.md"}] ["Path-based Routing" {:file "doc/basics/path_based_routing.md"}]
["Name-based Routing" {:file "doc/basics/name_based_routing.md"}] ["Name-based Routing" {:file "doc/basics/name_based_routing.md"}]
["Route Data" {:file "doc/basics/route_data.md"}] ["Route Data" {:file "doc/basics/route_data.md"}]
["Route Data Validation" ["Route Data Validation" {:file "doc/basics/route_data_validation.md"}]
{:file "doc/basics/route_data_validation.md"}]
["Route Conflicts" {:file "doc/basics/route_conflicts.md"}]] ["Route Conflicts" {:file "doc/basics/route_conflicts.md"}]]
["Coercion" ["Coercion"
{:file "doc/coercion/README.md"}
["Coercion Explained" {:file "doc/coercion/coercion.md"}] ["Coercion Explained" {:file "doc/coercion/coercion.md"}]
["Plumatic Schema" {:file "doc/coercion/schema_coercion.md"}] ["Plumatic Schema" {:file "doc/coercion/schema_coercion.md"}]
["Clojure.spec" {:file "doc/coercion/clojure_spec_coercion.md"}] ["Clojure.spec" {:file "doc/coercion/clojure_spec_coercion.md"}]
["Data-specs" {:file "doc/coercion/data_spec_coercion.md"}]] ["Data-specs" {:file "doc/coercion/data_spec_coercion.md"}]]
["Ring" ["Ring"
{:file "doc/ring/README.md"}
["Ring-router" {:file "doc/ring/ring.md"}] ["Ring-router" {:file "doc/ring/ring.md"}]
["Reverse-routing" {:file "doc/ring/reverse_routing.md"}] ["Reverse-routing" {:file "doc/ring/reverse_routing.md"}]
["Default handler" {:file "doc/ring/default_handler.md"}] ["Default handler" {:file "doc/ring/default_handler.md"}]
["Static Resources" {:file "doc/ring/static.md"}] ["Static Resources" {:file "doc/ring/static.md"}]
["Dynamic Extensions" {:file "doc/ring/dynamic_extensions.md"}] ["Dynamic Extensions" {:file "doc/ring/dynamic_extensions.md"}]
["Data-driven Middleware" ["Data-driven Middleware" {:file "doc/ring/data_driven_middleware.md"}]
{:file "doc/ring/data_driven_middleware.md"}] ["Transforming Middleware Chain" {:file "doc/ring/transforming_middleware_chain.md"}]
["Transforming Middleware Chain"
{:file "doc/ring/transforming_middleware_chain.md"}]
["Middleware Registry" {:file "doc/ring/middleware_registry.md"}] ["Middleware Registry" {:file "doc/ring/middleware_registry.md"}]
["Default Middleware" {:file "doc/ring/default_middleware.md"}] ["Default Middleware" {:file "doc/ring/default_middleware.md"}]
["Pluggable Coercion" {:file "doc/ring/coercion.md"}] ["Pluggable Coercion" {:file "doc/ring/coercion.md"}]
["Route Data Validation" ["Route Data Validation" {:file "doc/ring/route_data_validation.md"}]
{:file "doc/ring/route_data_validation.md"}]
["Compiling Middleware" {:file "doc/ring/compiling_middleware.md"}] ["Compiling Middleware" {:file "doc/ring/compiling_middleware.md"}]
["Swagger Support" {:file "doc/ring/swagger.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" ["Frontend"
{:file "doc/frontend/README.md"}
["Basics" {:file "doc/frontend/basics.md"}] ["Basics" {:file "doc/frontend/basics.md"}]
["Browser integration" {:file "doc/frontend/browser.md"}] ["Browser integration" {:file "doc/frontend/browser.md"}]
["Controllers (WIP)" {:file "doc/frontend/controllers.md"}]] ["Controllers (WIP)" {:file "doc/frontend/controllers.md"}]]
["Performance" {:file "doc/performance.md"}] ["HTTP"
["Interceptors (WIP)" {:file "doc/interceptors.md"}] ["Interceptors" {:file "doc/http/interceptors.md"}]]
["Development Instructions" {:file "doc/development.md"}] ["Advanced"
["FAQ" {:file "doc/faq.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"}]
["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"}]]]}

6
doc/coercion/README.md
View file

@ -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)

5
doc/frontend/README.md
View file

@ -1,5 +0,0 @@
# Frontend
* [Basics](basics.md)
* [Browser integration](browser.md)
* [Controllers (WIP)](controllers.md)

0
doc/interceptors.md → doc/http/interceptors.md
View file

3
doc/patterns/README.md
View file

@ -1,3 +0,0 @@
# Patterns
* [Shared Routes](shared_routes.md)

15
doc/ring/README.md
View file

@ -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)