Merge pull request #414 from lxsameer/feature/gitbook

Support for building docs using gitbook added.
This commit is contained in:
Mike Thompson 2017-09-26 21:25:23 +10:00 committed by GitHub
commit 668cfe845e
4 changed files with 60 additions and 3 deletions

9
.gitignore vendored
View File

@ -21,3 +21,12 @@ misc/
.flooignore
node_modules/
examples/todomvc/.idea/
docs/build/_book/
docs/build/index.html
docs/**/*.epub
docs/**/*.pdf
docs/**/*.mobi
build/
*~
yarn.lock
package-lock.json

10
book.json Normal file
View File

@ -0,0 +1,10 @@
{
"title": "re-frame",
"description": "Documentation of re-frame framework",
"language": "en",
"root": "./docs/",
"structure": {
"summary": "README.md"
}
}

View File

@ -1,4 +1,25 @@
### Introduction
---
description: re-frame official documentation
---
<img src="/images/logo/re-frame_128w.png?raw=true">
## Derived Values, Flowing
> This, milord, is my family's axe. We have owned it for almost nine hundred years, see. Of course,
sometimes it needed a new blade. And sometimes it has required a new handle, new designs on the
metalwork, a little refreshing of the ornamentation ... but is this not the nine hundred-year-old
axe of my family? And because it has changed gently over time, it is still a pretty good axe,
y'know. Pretty good.
> -- Terry Pratchett, The Fifth Elephant <br>
> &nbsp;&nbsp;&nbsp; reflecting on identity, flow and derived values
[![Clojars Project](https://img.shields.io/clojars/v/re-frame.svg)](https://clojars.org/re-frame)
[![GitHub license](https://img.shields.io/github/license/Day8/re-frame.svg)](license.txt)
[![Circle CI](https://circleci.com/gh/Day8/re-frame/tree/master.svg?style=shield&circle-token=:circle-ci-badge-token)](https://circleci.com/gh/Day8/re-frame/tree/master)
# Introduction
- [This Repo's README](../README.md)
- [app-db (Application State)](ApplicationState.md)
@ -8,7 +29,7 @@
### Alternative Introductions
- [purelyfunctional.tv](https://purelyfunctional.tv/guide/re-frame-building-blocks/) - a detailed, well written introduction.
- [purelyfunctional.tv](https://purelyfunctional.tv/guide/re-frame-building-blocks/) - a detailed, well written introduction.
- [Lambda Island Videos](https://lambdaisland.com/episodes) - commercial videos on many clojure topics, including re-frame and reagent.
### Dominoes 2 and 3 - Event Handlers
@ -66,4 +87,3 @@
<!-- We put these at the end so that there is nothing for doctoc to generate. -->
<!-- START doctoc -->
<!-- END doctoc -->

18
package.json Normal file
View File

@ -0,0 +1,18 @@
{
"name": "re-frame-docs",
"version": "1.0.0",
"main": "index.js",
"repository": "https://github.com/Day8/re-frame.git",
"scripts": {
"serve": "mkdir -p ./build/_book && gitbook serve ./ ./build/re-frame",
"epub": "gitbook epub ./ ./build/re-frame.epub",
"mobi": "gitbook mobi ./ ./build/re-frame.mobi",
"pdf": "gitbook pdf ./ ./build/re-frame.pdf",
"html": "gitbook build ./ ./build/re-frame",
"build": "npm run html && npm run pdf && npm run mobi && npm run epub"
},
"dependencies": {
"gitbook-cli": "^2.3.2",
"svgexport": "^0.3.2"
}
}