Migrate documentation to VuePress

GitBook development seems a bit stuck right now so let's switch to VuePress which, IMO, is more user friendly. Update the documentation to include the version number in which features were added and use custom container to display notes and warnings.
simonbrunel · Sep 9, 2018 · eebcb4f · eebcb4f
1 parent 051fed5
commit eebcb4f
Show file tree

Hide file tree

Showing 38 changed files with 297 additions and 155 deletions.
diff --git a/README.md b/README.md
@@ -1,6 +1,7 @@
 <a href="https://promisesaplus.com/" title="Promises/A+ 1.1"><img src="https://promisesaplus.com/assets/logo-small.png" alt="Promises/A+" align="right"/></a>
 
 # QtPromise
+
 [![qpm](https://img.shields.io/github/release/simonbrunel/qtpromise.svg?style=flat-square&label=qpm&colorB=4CAF50)](https://www.qpm.io/packages/com.github.simonbrunel.qtpromise/index.html) [![Travis](https://img.shields.io/travis/simonbrunel/qtpromise/master.svg?style=flat-square)](https://travis-ci.org/simonbrunel/qtpromise) [![coverage](https://img.shields.io/codecov/c/github/simonbrunel/qtpromise.svg?style=flat-square)](https://codecov.io/gh/simonbrunel/qtpromise)
 
 [Promises/A+](https://promisesaplus.com/) implementation for [Qt/C++](https://www.qt.io/).
@@ -9,10 +10,11 @@ Requires [Qt 5.6](https://www.qt.io/download/) (or later) with [C++11 support en
 
 ## Documentation
 
-* [Getting Started](https://qtpromise.netlify.com/qtpromise/getting-started)
-* [Thread-Safety](https://qtpromise.netlify.com/qtpromise/thread-safety)
-* [QtConcurrent](https://qtpromise.netlify.com/qtpromise/qtconcurrent)
-* [API Reference](https://qtpromise.netlify.com/qtpromise/api-reference)
+* [Getting Started](https://qtpromise.netlify.com/qtpromise/getting-started.html)
+* [QtConcurrent](https://qtpromise.netlify.com/qtpromise/qtconcurrent.html)
+* [Thread-Safety](https://qtpromise.netlify.com/qtpromise/thread-safety.html)
+* [API Reference](https://qtpromise.netlify.com/qtpromise/api-reference.html)
 
 ## License
+
 QtPromise is available under the [MIT license](LICENSE).
diff --git a/book.json b/book.json
diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js
@@ -0,0 +1,54 @@
+module.exports = {
+    title: 'QtPromise',
+    description: 'Promises/A+ implementation for Qt/C++',
+    ga: 'UA-113899811-1',
+    head: [
+        ['link', { rel: 'icon', href: `/favicon.png` }],
+    ],
+    themeConfig: {
+        repo: 'simonbrunel/qtpromise',
+        lastUpdated: 'Last Updated',
+        editLinks: true,
+        docsDir: 'docs',
+        sidebar: [
+            'qtpromise/getting-started',
+            'qtpromise/qtconcurrent',
+            'qtpromise/thread-safety',
+            'qtpromise/api-reference',
+            {
+                title: 'QPromise',
+                children: [
+                    'qtpromise/qpromise/constructor',
+                    'qtpromise/qpromise/delay',
+                    'qtpromise/qpromise/each',
+                    'qtpromise/qpromise/fail',
+                    'qtpromise/qpromise/filter',
+                    'qtpromise/qpromise/finally',
+                    'qtpromise/qpromise/isfulfilled',
+                    'qtpromise/qpromise/ispending',
+                    'qtpromise/qpromise/isrejected',
+                    'qtpromise/qpromise/map',
+                    'qtpromise/qpromise/tap',
+                    'qtpromise/qpromise/tapfail',
+                    'qtpromise/qpromise/then',
+                    'qtpromise/qpromise/timeout',
+                    'qtpromise/qpromise/wait',
+                    'qtpromise/qpromise/all.md',
+                    'qtpromise/qpromise/reject.md',
+                    'qtpromise/qpromise/resolve.md'
+                ]
+            },
+            {
+                title: 'Helpers',
+                children: [
+                    'qtpromise/helpers/attempt',
+                    'qtpromise/helpers/each',
+                    'qtpromise/helpers/filter',
+                    'qtpromise/helpers/map',
+                    'qtpromise/helpers/qpromise',
+                    'qtpromise/helpers/qpromiseall'
+                ]
+            }
+        ]
+    }
+}
diff --git a/docs/.vuepress/override.styl b/docs/.vuepress/override.styl
@@ -0,0 +1,2 @@
+$accentColor = #23b223
+$textColor = #404244
diff --git a/docs/.vuepress/public/favicon.ico b/docs/.vuepress/public/favicon.ico
diff --git a/docs/.vuepress/public/favicon.png b/docs/.vuepress/public/favicon.png
diff --git a/docs/.vuepress/style.styl b/docs/.vuepress/style.styl
@@ -0,0 +1,4 @@
+@import 'override.styl'
+
+.content a code
+    color: $accentColor
diff --git a/docs/README.md b/docs/README.md
@@ -5,11 +5,5 @@
 
 Requires [Qt 5.6](https://www.qt.io/download/) (or later) with [C++11 support enabled](https://wiki.qt.io/How_to_use_C++11_in_your_Qt_Projects).
 
-## QtPromise for C++
-* [Getting Started](qtpromise/getting-started.md)
-* [Thread-Safety](qtpromise/thread-safety.md)
-* [QtConcurrent](qtpromise/qtconcurrent.md)
-* [API Reference](qtpromise/api-reference.md)
-
 ## License
 QtPromise is available under the [MIT license](https://github.com/simonbrunel/qtpromise/blob/master/LICENSE).
diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md
diff --git a/docs/assets/style.css b/docs/assets/style.css
diff --git a/docs/qtpromise/api-reference.md b/docs/qtpromise/api-reference.md
@@ -1,6 +1,6 @@
-## QPromise
+# API Reference
 
-### Public Members
+## Functions
 
 * [`QPromise<T>::QPromise`](qpromise/constructor.md)
 * [`QPromise<T>::delay`](qpromise/delay.md)
@@ -18,17 +18,17 @@
 * [`QPromise<T>::timeout`](qpromise/timeout.md)
 * [`QPromise<T>::wait`](qpromise/wait.md)
 
-### Public Static Members
+## Static Functions
 
 * [`[static] QPromise<T>::all`](qpromise/all.md)
 * [`[static] QPromise<T>::reject`](qpromise/reject.md)
 * [`[static] QPromise<T>::resolve`](qpromise/resolve.md)
 
 ## Helpers
 
-* [`qPromise`](helpers/qpromise.md)
-* [`qPromiseAll`](helpers/qpromiseall.md)
 * [`QtPromise::attempt`](helpers/attempt.md)
 * [`QtPromise::each`](helpers/each.md)
 * [`QtPromise::filter`](helpers/filter.md)
 * [`QtPromise::map`](helpers/map.md)
+* [`qPromise`](helpers/qpromise.md)
+* [`qPromiseAll`](helpers/qpromiseall.md)
diff --git a/docs/qtpromise/getting-started.md b/docs/qtpromise/getting-started.md
@@ -1,8 +1,10 @@
+# Getting Started
+
 ## Installation
 
 QtPromise is a [header-only](https://en.wikipedia.org/wiki/Header-only) library, simply download the [latest release](https://github.com/simonbrunel/qtpromise/releases/latest) (or [`git submodule`](https://git-scm.com/docs/git-submodule)) and include `qtpromise.pri` from your project `.pro`.
 
-## qpm
+### qpm
 
 Alternatively and **only** if your project relies on [qpm](https://www.qpm.io/), you can install QtPromise as follow:
 

diff --git a/docs/qtpromise/helpers/attempt.md b/docs/qtpromise/helpers/attempt.md
@@ -1,4 +1,10 @@
-## `QtPromise::attempt`
+---
+title: attempt
+---
+
+# QtPromise::attempt
+
+*Since: 0.4.0*
 
 ```cpp
 QtPromise::attempt(Functor functor, Args...) -> QPromise<R>

diff --git a/docs/qtpromise/helpers/each.md b/docs/qtpromise/helpers/each.md
@@ -1,4 +1,10 @@
-## `QtPromise::each`
+---
+title: each
+---
+
+# QtPromise::each
+
+*Since: 0.4.0*
 
 ```cpp
 QtPromise::each(Sequence<T> values, Functor functor) -> QPromise<Sequence<T>>
@@ -8,10 +14,10 @@ QtPromise::each(Sequence<T> values, Functor functor) -> QPromise<Sequence<T>>
 // - Functor: Function(T value, int index) -> void | QPromise<void>
 ```
 
-Calls the given `functor` on each element in `values` then resolves to the original sequence 
-unmodified. If `functor` throws, `output` is rejected with the new exception. 
+Calls the given `functor` on each element in `values` then resolves to the original sequence
+unmodified. If `functor` throws, `output` is rejected with the new exception.
 
-If `functor` returns a promise (or `QFuture`), the `output` promise is delayed until all the 
+If `functor` returns a promise (or `QFuture`), the `output` promise is delayed until all the
 promises are resolved. If any of the promises fail, `output` immediately rejects with the error
 of the promise that rejected, whether or not the other promises are resolved.
 

diff --git a/docs/qtpromise/helpers/filter.md b/docs/qtpromise/helpers/filter.md
@@ -1,4 +1,10 @@
-## `QtPromise::filter`
+---
+title: filter
+---
+
+# QtPromise::filter
+
+*Since: 0.4.0*
 
 ```cpp
 QtPromise::filter(Sequence<T> values, Filterer filterer) -> QPromise<Sequence<T>>
@@ -38,7 +44,9 @@ output.then([](const QVector<QUrl>& res) {
 });
 ```
 
-> **Note:** the order of the output sequence values is guarantee to be the same as the original
+::: tip NOTE
+The order of the output sequence values is guarantee to be the same as the original
 sequence, regardless of completion order of the promises returned by `filterer`.
+:::
 
 See also: [`QPromise<T>::filter`](../qpromise/filter.md)
diff --git a/docs/qtpromise/helpers/map.md b/docs/qtpromise/helpers/map.md
@@ -1,4 +1,10 @@
-## `QtPromise::map`
+---
+title: map
+---
+
+# QtPromise::map
+
+*Since: 0.4.0*
 
 ```cpp
 QtPromise::map(Sequence<T> values, Mapper mapper) -> QPromise<QVector<R>>
@@ -37,7 +43,9 @@ output.then([](const QVector<QByteArray>& res) {
 });
 ```
 
-> **Note:** the order of the output sequence values is guarantee to be the same as the original
+::: tip NOTE
+The order of the output sequence values is guarantee to be the same as the original
 sequence, regardless of completion order of the promises returned by `mapper`.
+:::
 
 See also: [`QPromise<T>::map`](../qpromise/map.md)
diff --git a/docs/qtpromise/helpers/qpromise.md b/docs/qtpromise/helpers/qpromise.md
@@ -1,4 +1,10 @@
-## `qPromise`
+---
+title: qPromise
+---
+
+# qPromise
+
+*Since: 0.1.0*
 
 ```
 qPromise(T value) -> QPromise<R>

diff --git a/docs/qtpromise/helpers/qpromiseall.md b/docs/qtpromise/helpers/qpromiseall.md
@@ -1,4 +1,10 @@
-## `qPromiseAll`
+---
+title: qPromiseAll
+---
+
+# qPromiseAll
+
+*Since: 0.1.0*
 
 ```
 qPromiseAll(Sequence<QPromise<T>> promises) -> QPromise<QVector<T>>

diff --git a/docs/qtpromise/qpromise/all.md b/docs/qtpromise/qpromise/all.md
@@ -1,4 +1,10 @@
-## `[static] QPromise<T>::all`
+---
+title: ::all [static]
+---
+
+# QPromise::all [static]
+
+*Since: 0.1.0*
 
 ```
 [static] QPromise<T>::all(Sequence<QPromise<T>> promises) -> QPromise<QVector<T>>

diff --git a/docs/qtpromise/qpromise/constructor.md b/docs/qtpromise/qpromise/constructor.md
@@ -1,6 +1,12 @@
-## `QPromise<T>::QPromise`
+---
+title: constructor
+---
 
-```
+# QPromise::QPromise
+
+*Since: 0.1.0*
+
+```cpp
 QPromise<T>::QPromise(Function resolver)
 ```
 
@@ -18,7 +24,9 @@ QPromise<int> promise([](const QPromiseResolve<int>& resolve, const QPromiseReje
 });
 ```
 
-> **Note:** `QPromise<void>` is specialized to not contain any value, meaning that the `resolve` callback takes no argument.
+::: tip NOTE
+`QPromise<void>` is specialized to not contain any value, meaning that the `resolve` callback takes no argument.
+:::
 
 **C++14**
 

diff --git a/docs/qtpromise/qpromise/delay.md b/docs/qtpromise/qpromise/delay.md
@@ -1,6 +1,12 @@
-## `QPromise<T>::delay`
+---
+title: .delay
+---
 
-```
+# QPromise::delay
+
+*Since: 0.2.0*
+
+```cpp
 QPromise<T>::delay(int msec) -> QPromise<T>
 ```