Use gitbook

Author: kornilova203

.gitignore

@@ -1,3 +1,4 @@
 target/
 scripts/.coursier
 scripts/.scalafmt-*
+/docs/_book/

build.sbt

@@ -88,13 +88,3 @@ lazy val samples = project
   )
 
 lazy val tools = project in file("tools")
-
-lazy val docs = project
-  .in(file("docs"))
-  .enablePlugins(ParadoxPlugin)
-  .settings(
-    paradoxTheme := Some(builtinParadoxTheme("generic")),
-    paradoxProperties in Compile ++= Map(
-      "github.base_url" -> "https://github.com/kornilova-l/scala-native-bindgen/tree/master/"
-    )
-  )

docs/src/main/paradox/index.md renamed to docs/README.md

@@ -1,19 +1,11 @@
 # Scala Native Bindgen
 
-@@@ index
-
-* [Obtaining bindgen](obtaining-bindgen/index.md)
-* [Usage](command-line-usage/index.md)
-* [Limitations](limitations/index.md)
-
-@@@
-
 This tool generates Scala Native bindings from C headers.
 It's built upon clang and [LibTooling] and thus respects the conventions of clang-tools.
 
 ## License
 
 This project is distributed under the Scala license.
-@github[See LICENSE.txt for details](/LICENSE.txt)
+[See LICENSE.txt for details](/LICENSE.txt)
 
  [LibTooling]: https://clang.llvm.org/docs/LibTooling.html

docs/SUMMARY.md

@@ -0,0 +1,9 @@
+# Summary
+
+* [Obtaining bindgen](obtaining-bindgen/README.md)
+    * [Use docker container](obtaining-bindgen/docker-container.md)
+    * [Build binary with CMake](obtaining-bindgen/cmake.md)
+    * [Build binary with docker-compose](obtaining-bindgen/docker-compose.md)
+* [Usage](command-line-usage/README.md)
+* [Limitations](limitations/README.md)
+

docs/src/main/paradox/command-line-usage/index.md renamed to docs/command-line-usage/README.md

@@ -30,6 +30,9 @@ There are multiple unsupported cases that should be considered when generating b
     ```
 
  3. There is no way to reuse already generated bindings.  
-    Bindgen outputs bindings also for headers that were included in a given header. See @github[#2](#2).
+    Bindgen outputs bindings also for headers that were included in a given header. See [#2].
  4. Type qualifiers `const`, `volatile` and `restrict` are not supported.
- 5. Extern variables are read-only. See @github[scala-native/scala-native#202](scala-native/scala-native#202).
+ 5. Extern variables are read-only. See [scala-native/scala-native#202].
+
+ [#2]: https://github.com/kornilova-l/scala-native-bindgen/issues/2
+ [scala-native/scala-native#202]: https://github.com/scala-native/scala-native/issues/202

docs/src/main/paradox/limitations/index.md renamed to docs/limitations/README.md

@@ -1,9 +1,6 @@
 # Obtaining Bindgen
 
-@@@ index
-
+There are 3 ways to obtain bindgen:
  * [Use docker container](docker-container.md)
  * [Build binary with CMake](cmake.md)
  * [Build binary with docker-compose](docker-compose.md)
-
-@@@

docs/src/main/paradox/obtaining-bindgen/index.md renamed to docs/obtaining-bindgen/README.md

@@ -18,13 +18,15 @@ docker run -v "$(pwd)":/src -v /usr/include:/usr/include \
 
 The docker image does not contain standard headers so it is important to
 mount all system include directories that are used by the header file
-passed to `scala-native-bindgen`. See the @github[docker-bindgen.sh](/scripts/docker-bindgen.sh) script for
-how to wrap the dockerized program. The `$CWD` of the container is
-`/src` which should be mounted from `$(pwd)` in case relative paths are
-used.
+passed to `scala-native-bindgen`.
+
+See the [docker-bindgen.sh] script for how to wrap the dockerized program.
+The `$CWD` of the container is `/src` which should be mounted from `$(pwd)`
+in case relative paths are used.
 
 Note, the `scalabindgen/scala-native-bindgen:latest` image is updated on
 each merge to the `master` branch.
 
  [Docker]: https://www.docker.com/
+ [docker-bindgen.sh]: https://github.com/kornilova-l/scala-native-bindgen/blob/master/scripts/docker-bindgen.sh