Initialize empty frontend docs

This commit is contained in:
Juho Teperi 2018-07-11 13:27:30 +03:00
parent 82f8aaa8cf
commit 73b1efd5b3
6 changed files with 23 additions and 1 deletions

View file

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

View file

@ -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"}]

5
doc/frontend/README.md Normal file
View file

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

3
doc/frontend/basics.md Normal file
View file

@ -0,0 +1,3 @@
# Frontend basics
TODO

3
doc/frontend/browser.md Normal file
View file

@ -0,0 +1,3 @@
# Frontend browser integration
TODO

View file

@ -0,0 +1,3 @@
# Controllers
TODO