Add cljsdoc config and rename docs/ to doc/

This commit is contained in:
Juho Teperi 2018-05-27 18:47:20 +03:00
parent d7529a8e60
commit 5548ad0866
20 changed files with 35 additions and 16 deletions

View File

@ -16,7 +16,7 @@
**[compare](https://github.com/reagent-project/reagent/compare/v0.8.0-rc1...v0.8.0)**
- Reagent documentation is now maintained as part of the repository, in [docs](./docs) folder.
- Reagent documentation is now maintained as part of the repository, in [doc](./doc) folder.
- Default to React 16
- Apply vector metadata to the outermost element when using nesting shorthand ([#262](https://github.com/reagent-project/reagent/issues/262))
- Add `:<>` shorthand for [React Fragments](https://reactjs.org/docs/fragments.html) ([#352](https://github.com/reagent-project/reagent/pull/352)])
@ -25,7 +25,7 @@
- Added `IWithMeta` to `RAtom` ([#314](https://github.com/reagent-project/reagent/pull/314))
- Support for using Reagent together with React from npm
#### Read [0.8 upgrade guide](./docs/0.8-upgrade.md) for more information.
#### Read [0.8 upgrade guide](./doc/0.8-upgrade.md) for more information.
## 0.8.0-rc1 (2018-04-11)
@ -33,7 +33,7 @@
Unless defaulting to React 16 causes problems, final release should follow soon.
- Reagent documentation is now maintained as part of the repository, in [docs](./docs) folder.
- Reagent documentation is now maintained as part of the repository, in [doc](./doc) folder.
- Default to React 16
- Apply vector metadata to the outermost element when using nesting shorthand ([#262](https://github.com/reagent-project/reagent/issues/262))
- Add `:<>` shorthand for [React Fragments](https://reactjs.org/docs/fragments.html) ([#352](https://github.com/reagent-project/reagent/pull/352)])
@ -118,7 +118,7 @@ React-with-addons bundle [has been deprecated](https://facebook.github.io/react/
of that package. The latest React-with-addons version won't work with Reagent 0.8.
For animation utils use [react-transition-group](https://github.com/cljsjs/packages/tree/master/react-transition-group) package instead. [React-dom/test-utils](https://facebook.github.io/react/docs/test-utils.html) and [react-addons-perf](https://facebook.github.io/react/docs/perf.html) are not currently packaged as browserified files, so their use would require Webpack, or they might work with Closure module processing (TODO: Provide example).
#### Read [0.8 upgrade guide](./docs/0.8-upgrade.md) for more information.
#### Read [0.8 upgrade guide](./doc/0.8-upgrade.md) for more information.
#### Which libraries work together with Reagent 0.8:

View File

@ -8,7 +8,7 @@ Reagent provides a way to write efficient React components using (almost) nothin
* **[Detailed intro with live examples](http://reagent-project.github.io/)**
* **[News](http://reagent-project.github.io/news/index.html)**
* **[API Documentation](http://reagent-project.github.io/docs/master/)**
* **[Tutorials and FAQ](https://github.com/reagent-project/reagent/tree/master/docs)**
* **[Tutorials and FAQ](https://github.com/reagent-project/reagent/tree/master/doc)**
* **Community discussion and support channels**
* **[#reagent](https://clojurians.slack.com/messages/reagent/)** channel in [Clojure Slack](http://clojurians.net/)
* **[Reagent Project Mailing List](https://groups.google.com/forum/#!forum/reagent-project)**

View File

@ -1,19 +1,19 @@
## Tutorials
1. [Using Hiccup to Describe HTML](/docs/UsingHiccupToDescribeHTML.md)
2. [Creating Reagent Components](/docs/CreatingReagentComponents.md)
3. [Using [square brackets] instead of (parentheses)](/docs/UsingSquareBracketsInsteadOfParens.md)
4. [When do components update?](/docs/WhenDoComponentsUpdate.md)
5. [[WIP] Managing State: atoms, cursors, Reactions, and tracking](/docs/ManagingState.md)
6. [Batching and Timing: How Reagent Renders Changes to Application State](/docs/BatchingAndTiming.md)
7. [Interop with React](/docs/InteropWithReact.md)
1. [Using Hiccup to Describe HTML](UsingHiccupToDescribeHTML.md)
2. [Creating Reagent Components](CreatingReagentComponents.md)
3. [Using [square brackets] instead of (parentheses)](UsingSquareBracketsInsteadOfParens.md)
4. [When do components update?](WhenDoComponentsUpdate.md)
5. [[WIP] Managing State: atoms, cursors, Reactions, and tracking](ManagingState.md)
6. [Batching and Timing: How Reagent Renders Changes to Application State](BatchingAndTiming.md)
7. [Interop with React](InteropWithReact.md)
Also:
* [purelyfunctional.tv ](https://purelyfunctional.tv/guide/reagent/) - an excellent, written tutorial
* [Reagent Deep Dive Series by Timothy Pratley](http://timothypratley.blogspot.com.au/p/p.html) - a four part series
* [Reagent Mysteries series by Paulus Esterhazy](https://presumably.de/) - a four part series
* [Props, Children & Component Lifecycle](https://www.martinklepsch.org/posts/props-children-and-component-lifecycle-in-reagent.html) by Martin Klepsch
* [Using Stateful JS Components - like D3](https://github.com/Day8/re-frame/blob/master/docs/Using-Stateful-JS-Components.md) (external link)
* [Using Stateful JS Components - like D3](https://github.com/Day8/re-frame/blob/masterUsing-Stateful-JS-Components.md) (external link)
## Commercial Videos Series
@ -40,5 +40,5 @@ Many Thanks!! We'd like that:
#### Misc Docs
- [0.8-upgrade](/docs/0.8-upgrade.md)
- [development](/docs/development.md)
- [0.8-upgrade](0.8-upgrade.md)
- [development](development.md)

19
doc/cljdoc.edn Normal file
View File

@ -0,0 +1,19 @@
{:cljdoc.doc/tree [["Documention index" {:file "doc/README.md"}]
["Tutorials" {}
["Using Hiccup to Describe HTML" {:file "doc/UsingHiccupToDescribeHTML.md"}]
["Creating Reagent Components" {:file "doc/CreatingReagentComponents.md"}]
["Using [square brackets] instead of (parentheses)" {:file "doc/UsingSquareBracketsInsteadOfParens.md"}]
["When do components update?" {:file "doc/WhenDoComponentsUpdate.md"}]
["[WIP] Managing State: atoms, cursors, Reactions, and tracking" {:file "doc/ManagingState.md"}]
["Batching and Timing: How Reagent Renders Changes to Application State" {:file "doc/BatchingAndTiming.md"}]
["Interop with React" {:file "doc/InteropWithReact.md"}]]
["Frequently Asked Questions" {}
["Why isn't my Component re-rendering?" {:file "doc/FAQ/ComponentNotRerendering.md"}]
["How do I use React's \"refs\"" {:file "doc/FAQ/UsingRefs.md"}]
["How can I use an entity like \"nbsp\"?" {:file "doc/FAQ/UsingAnEntity.md"}]
["Why is my attribute (like autoFocus) missing?" {:file "doc/FAQ/MyAttributesAreMissing.md"}]
["How can I use React's dangerouslySetInnerHTML?" {:file "doc/FAQ/dangerouslySetInnerHTML.md"}]
["Reagent doesn't work after updating dependencies" {:file "doc/FAQ/CljsjsReactProblems.md"}]]
["Other" {}
["0.8 Upgrade guide" {:file "doc/0.8-upgrade.md"}]
["Development guide" {:file "doc/development.md"}]]]}

View File

@ -1,4 +1,4 @@
(defproject reagent "0.8.1"
(defproject reagent "0.8.2-SNAPSHOT"
:url "http://github.com/reagent-project/reagent"
:license {:name "MIT"}
:description "A simple ClojureScript interface to React"