summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorTobias Roeser <le.petit.fou@web.de>2018-10-21 14:05:50 +0200
committerTobias Roeser <le.petit.fou@web.de>2018-10-26 08:26:25 +0200
commit2ccad83244b2630ba4183d926a91d8b3f92b9a31 (patch)
treefd49cfc6efef298e2f12c40050ae2be8131e5594 /docs
parentc10e342b904a9c120b323ab08709e97e7589cd57 (diff)
downloadmill-2ccad83244b2630ba4183d926a91d8b3f92b9a31.tar.gz
mill-2ccad83244b2630ba4183d926a91d8b3f92b9a31.tar.bz2
mill-2ccad83244b2630ba4183d926a91d8b3f92b9a31.zip
Re-organized thirdparty plugin section
Each plugin is a level-3 section, that appears also in TOC. Plugins are in alphabetical order.
Diffstat (limited to 'docs')
-rw-r--r--docs/pages/9 - Contrib Modules.md168
1 files changed, 91 insertions, 77 deletions
diff --git a/docs/pages/9 - Contrib Modules.md b/docs/pages/9 - Contrib Modules.md
index f9270e38..aa7b21a7 100644
--- a/docs/pages/9 - Contrib Modules.md
+++ b/docs/pages/9 - Contrib Modules.md
@@ -82,87 +82,101 @@ Quickstart:
The package name of the object.
-### Other Mill Plugins
+## Thirdparty Mill Plugins
-- [ensime](https://github.com/yyadavalli/mill-ensime "mill-ensime")
-
- Create an [.ensime](http://ensime.github.io/ "ensime") file for your build.
-
- Quickstart:
- ```scala
- import $ivy.`fun.valycorp::mill-ensime:0.0.1`
- ```
- ```sh
- sh> mill fun.valycorp.mill.GenEnsime/ensimeConfig
- ```
+### DGraph
-- [dgraph](https://github.com/ajrnz/mill-dgraph "mill-dgraph")
+Show transitive dependencies of your build in your browser.
- Show transitive dependencies of your build in your browser.
-
- Quickstart:
- ```scala
- import $ivy.`com.github.ajrnz::mill-dgraph:0.2.0`
- ```
- ```sh
- sh> mill plugin.dgraph.browseDeps(proj)()
- ```
+Project home: https://github.com/ajrnz/mill-dgraph
-- [publishM2](https://github.com/lefou/mill-publishM2 "mill-publishM2")
-
- Mill plugin to publish artifacts into a local Maven repository.
-
- Quickstart:
-
- Just mix-in the `PublishM2Module` into your project.
- `PublishM2Module` already extends mill's built-in `PublishModule`.
-
- File: `build.sc`
- ```scala
- import mill._, scalalib._, publish._
-
- import $ivy.`de.tototec::de.tobiasroeser.mill.publishM2:0.0.1`
- import de.tobiasroeser.mill.publishM2._
-
- object project extends PublishModule with PublishM2Module {
- // ...
- }
- ```
-
- Publishing to default local Maven repository
-
- ```bash
- > mill project.publishM2Local
- [40/40] project.publishM2Local
- Publishing to /home/user/.m2/repository
- ```
-
- Publishing to custom local Maven repository
-
- ```bash
- > mill project.publishM2Local /tmp/m2repo
- [40/40] project.publishM2Local
- Publishing to /tmp/m2repo
- ```
+#### Quickstart
-- [osgi](https://github.com/lefou/mill-osgi "GitHub-Project lefou/mill-osgi")
-
- Produce OSGi Bundles with mill.
-
- Quickstart:
- ```scala
- import $ivy.`de.tototec::de.tobiasroeser.mill.osgi:0.0.2`
- import de.tobiasroeser.mill.osgi._
-
- object project extends ScalaModule with OsgiBundleModule {
-
- def bundleSymbolicName = "com.example.project"
-
- def osgiHeaders = T{ osgiHeaders().copy(
- `Export-Package` = Seq("com.example.api"),
- `Bundle-Activator` = Some("com.example.internal.Activator")
- )}
+```scala
+import $ivy.`com.github.ajrnz::mill-dgraph:0.2.0`
+```
+
+```sh
+sh> mill plugin.dgraph.browseDeps(proj)()
+```
+
+### Ensime
+
+Create an [.ensime](http://ensime.github.io/ "ensime") file for your build.
+
+Project home: https://github.com/yyadavalli/mill-ensime
- }
- ```
+#### Quickstart
+
+```scala
+import $ivy.`fun.valycorp::mill-ensime:0.0.1`
+```
+
+```sh
+sh> mill fun.valycorp.mill.GenEnsime/ensimeConfig
+```
+
+### OSGi
+
+Produce OSGi Bundles with mill.
+
+Project home: https://github.com/lefou/mill-osgi
+
+#### Quickstart
+
+```scala
+import $ivy.`de.tototec::de.tobiasroeser.mill.osgi:0.0.2`
+import de.tobiasroeser.mill.osgi._
+
+object project extends ScalaModule with OsgiBundleModule {
+
+ def bundleSymbolicName = "com.example.project"
+
+ def osgiHeaders = T{ osgiHeaders().copy(
+ `Export-Package` = Seq("com.example.api"),
+ `Bundle-Activator` = Some("com.example.internal.Activator")
+ )}
+
+}
+```
+
+
+### PublishM2
+
+Mill plugin to publish artifacts into a local Maven repository.
+
+Project home: https://github.com/lefou/mill-publishM2
+
+#### Quickstart
+
+Just mix-in the `PublishM2Module` into your project.
+`PublishM2Module` already extends mill's built-in `PublishModule`.
+
+File: `build.sc`
+```scala
+import mill._, scalalib._, publish._
+
+import $ivy.`de.tototec::de.tobiasroeser.mill.publishM2:0.0.1`
+import de.tobiasroeser.mill.publishM2._
+
+object project extends PublishModule with PublishM2Module {
+ // ...
+}
+```
+
+Publishing to default local Maven repository
+
+```bash
+> mill project.publishM2Local
+[40/40] project.publishM2Local
+Publishing to /home/user/.m2/repository
+```
+
+Publishing to custom local Maven repository
+
+```bash
+> mill project.publishM2Local /tmp/m2repo
+[40/40] project.publishM2Local
+Publishing to /tmp/m2repo
+```