Skip to content

Commit c487b27

Browse files
committed
initial rework
1 parent 2c51f05 commit c487b27

File tree

11 files changed

+75
-111
lines changed

11 files changed

+75
-111
lines changed

book.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"root": "doc",
3-
"plugins": ["editlink", "github", "highlight"],
3+
"plugins": ["hints", "editlink", "github", "highlight"],
44
"pluginsConfig": {
55
"editlink": {
66
"base": "https://github.com/metosin/reitit/tree/master/doc",

doc/SUMMARY.md

+57-40
Original file line numberDiff line numberDiff line change
@@ -1,46 +1,63 @@
11
# Summary
22

3+
## Introduction
4+
35
* [Introduction](README.md)
4-
* [Basics](basics/README.md)
5-
* [Route Syntax](basics/route_syntax.md)
6-
* [Router](basics/router.md)
7-
* [Path-based Routing](basics/path_based_routing.md)
8-
* [Name-based Routing](basics/name_based_routing.md)
9-
* [Route Data](basics/route_data.md)
10-
* [Route Data Validation](basics/route_data_validation.md)
11-
* [Route Conflicts](basics/route_conflicts.md)
12-
* [Coercion](coercion/README.md)
13-
* [Coercion Explained](coercion/coercion.md)
14-
* [Plumatic Schema](coercion/schema_coercion.md)
15-
* [Clojure.spec](coercion/clojure_spec_coercion.md)
16-
* [Data-specs](coercion/data_spec_coercion.md)
17-
* [Ring](ring/README.md)
18-
* [Ring-router](ring/ring.md)
19-
* [Reverse-routing](ring/reverse_routing.md)
20-
* [Default handler](ring/default_handler.md)
21-
* [Static Resources](ring/static.md)
22-
* [Dynamic Extensions](ring/dynamic_extensions.md)
23-
* [Data-driven Middleware](ring/data_driven_middleware.md)
24-
* [Transforming Middleware Chain](ring/transforming_middleware_chain.md)
25-
* [Middleware Registry](ring/middleware_registry.md)
26-
* [Default Middleware](ring/default_middleware.md)
27-
* [Pluggable Coercion](ring/coercion.md)
28-
* [Route Data Validation](ring/route_data_validation.md)
29-
* [Compiling Middleware](ring/compiling_middleware.md)
30-
* [Swagger Support](ring/swagger.md)
31-
* [Advanced](advanced/README.md)
32-
* [Configuring Routers](advanced/configuring_routers.md)
33-
* [Composing Routers](advanced/composing_routers.md)
34-
* [Different Routers](advanced/different_routers.md)
35-
* [Route Validation](advanced/route_validation.md)
36-
* [Dev Workflow](advanced/dev_workflow.md)
37-
* [Patterns](patterns/README.md)
38-
* [Shared Routes](patterns/shared_routes.md)
39-
* [Frontend](frontend/README.md)
40-
* [Basics](frontend/basics.md)
41-
* [Browser integration](frontend/browser.md)
42-
* [Controllers (WIP)](frontend/controllers.md)
6+
7+
## Basics
8+
9+
* [Route Syntax](basics/route_syntax.md)
10+
* [Router](basics/router.md)
11+
* [Path-based Routing](basics/path_based_routing.md)
12+
* [Name-based Routing](basics/name_based_routing.md)
13+
* [Route Data](basics/route_data.md)
14+
* [Route Data Validation](basics/route_data_validation.md)
15+
* [Route Conflicts](basics/route_conflicts.md)
16+
17+
## Coercion
18+
19+
* [Coercion Explained](coercion/coercion.md)
20+
* [Plumatic Schema](coercion/schema_coercion.md)
21+
* [Clojure.spec](coercion/clojure_spec_coercion.md)
22+
* [Data-specs](coercion/data_spec_coercion.md)
23+
24+
## Ring
25+
26+
* [Ring-router](ring/ring.md)
27+
* [Reverse-routing](ring/reverse_routing.md)
28+
* [Default handler](ring/default_handler.md)
29+
* [Static Resources](ring/static.md)
30+
* [Dynamic Extensions](ring/dynamic_extensions.md)
31+
* [Data-driven Middleware](ring/data_driven_middleware.md)
32+
* [Transforming Middleware Chain](ring/transforming_middleware_chain.md)
33+
* [Middleware Registry](ring/middleware_registry.md)
34+
* [Default Middleware](ring/default_middleware.md)
35+
* [Pluggable Coercion](ring/coercion.md)
36+
* [Route Data Validation](ring/route_data_validation.md)
37+
* [Compiling Middleware](ring/compiling_middleware.md)
38+
* [Swagger Support](ring/swagger.md)
39+
40+
## Frontend
41+
42+
* [Basics](frontend/basics.md)
43+
* [Browser integration](frontend/browser.md)
44+
* [Controllers (WIP)](frontend/controllers.md)
45+
46+
## HTTP
47+
48+
* [Interceptors](http/interceptors.md)
49+
50+
## Advanced
51+
52+
* [Configuring Routers](advanced/configuring_routers.md)
53+
* [Composing Routers](advanced/composing_routers.md)
54+
* [Different Routers](advanced/different_routers.md)
55+
* [Route Validation](advanced/route_validation.md)
56+
* [Dev Workflow](advanced/dev_workflow.md)
57+
* [Shared Routes](advanced/shared_routes.md)
58+
59+
## Misc
60+
4361
* [Performance](performance.md)
44-
* [Interceptors (WIP)](interceptors.md)
4562
* [Development Instructions](development.md)
4663
* [FAQ](faq.md)

doc/advanced/README.md

-6
This file was deleted.
File renamed without changes.

doc/basics/README.md

-9
This file was deleted.

doc/cljdoc.edn

+17-26
Original file line numberDiff line numberDiff line change
@@ -9,56 +9,47 @@
99
:cljdoc.doc/tree
1010
[["Introduction" {:file "doc/README.md"}]
1111
["Basics"
12-
{:file "doc/basics/README.md"}
1312
["Route Syntax" {:file "doc/basics/route_syntax.md"}]
1413
["Router" {:file "doc/basics/router.md"}]
1514
["Path-based Routing" {:file "doc/basics/path_based_routing.md"}]
1615
["Name-based Routing" {:file "doc/basics/name_based_routing.md"}]
1716
["Route Data" {:file "doc/basics/route_data.md"}]
18-
["Route Data Validation"
19-
{:file "doc/basics/route_data_validation.md"}]
17+
["Route Data Validation" {:file "doc/basics/route_data_validation.md"}]
2018
["Route Conflicts" {:file "doc/basics/route_conflicts.md"}]]
2119
["Coercion"
22-
{:file "doc/coercion/README.md"}
2320
["Coercion Explained" {:file "doc/coercion/coercion.md"}]
2421
["Plumatic Schema" {:file "doc/coercion/schema_coercion.md"}]
2522
["Clojure.spec" {:file "doc/coercion/clojure_spec_coercion.md"}]
2623
["Data-specs" {:file "doc/coercion/data_spec_coercion.md"}]]
2724
["Ring"
28-
{:file "doc/ring/README.md"}
2925
["Ring-router" {:file "doc/ring/ring.md"}]
3026
["Reverse-routing" {:file "doc/ring/reverse_routing.md"}]
3127
["Default handler" {:file "doc/ring/default_handler.md"}]
3228
["Static Resources" {:file "doc/ring/static.md"}]
3329
["Dynamic Extensions" {:file "doc/ring/dynamic_extensions.md"}]
34-
["Data-driven Middleware"
35-
{:file "doc/ring/data_driven_middleware.md"}]
36-
["Transforming Middleware Chain"
37-
{:file "doc/ring/transforming_middleware_chain.md"}]
30+
["Data-driven Middleware" {:file "doc/ring/data_driven_middleware.md"}]
31+
["Transforming Middleware Chain" {:file "doc/ring/transforming_middleware_chain.md"}]
3832
["Middleware Registry" {:file "doc/ring/middleware_registry.md"}]
3933
["Default Middleware" {:file "doc/ring/default_middleware.md"}]
4034
["Pluggable Coercion" {:file "doc/ring/coercion.md"}]
41-
["Route Data Validation"
42-
{:file "doc/ring/route_data_validation.md"}]
35+
["Route Data Validation" {:file "doc/ring/route_data_validation.md"}]
4336
["Compiling Middleware" {:file "doc/ring/compiling_middleware.md"}]
4437
["Swagger Support" {:file "doc/ring/swagger.md"}]]
38+
["Frontend"
39+
["Basics" {:file "doc/frontend/basics.md"}]
40+
["Browser integration" {:file "doc/frontend/browser.md"}]
41+
["Controllers (WIP)" {:file "doc/frontend/controllers.md"}]]
42+
["HTTP"
43+
["Interceptors" {:file "doc/http/interceptors.md"}]]
4544
["Advanced"
46-
{:file "doc/advanced/README.md"}
47-
["Configuring Routers"
48-
{:file "doc/advanced/configuring_routers.md"}]
45+
["Configuring Routers" {:file "doc/advanced/configuring_routers.md"}]
4946
["Composing Routers" {:file "doc/advanced/composing_routers.md"}]
5047
["Different Routers" {:file "doc/advanced/different_routers.md"}]
5148
["Route Validation" {:file "doc/advanced/route_validation.md"}]
52-
["Dev Workflow" {:file "doc/advanced/dev_workflow.md"}]]
53-
["Patterns"
54-
{:file "doc/patterns/README.md"}
49+
["Dev Workflow" {:file "doc/advanced/dev_workflow.md"}]
5550
["Shared Routes" {:file "doc/patterns/shared_routes.md"}]]
56-
["Frontend"
57-
{:file "doc/frontend/README.md"}
58-
["Basics" {:file "doc/frontend/basics.md"}]
59-
["Browser integration" {:file "doc/frontend/browser.md"}]
60-
["Controllers (WIP)" {:file "doc/frontend/controllers.md"}]]
61-
["Performance" {:file "doc/performance.md"}]
62-
["Interceptors (WIP)" {:file "doc/interceptors.md"}]
63-
["Development Instructions" {:file "doc/development.md"}]
64-
["FAQ" {:file "doc/faq.md"}]]}
51+
["Misc"
52+
["Performance" {:file "doc/performance.md"}]
53+
["Interceptors (WIP)" {:file "doc/interceptors.md"}]
54+
["Development Instructions" {:file "doc/development.md"}]
55+
["FAQ" {:file "doc/faq.md"}]]]}

doc/coercion/README.md

-6
This file was deleted.

doc/frontend/README.md

-5
This file was deleted.
File renamed without changes.

doc/patterns/README.md

-3
This file was deleted.

doc/ring/README.md

-15
This file was deleted.

0 commit comments

Comments
 (0)