Skip to content

Commit fa25b5d

Browse files
committed
Add simple Antora docs.
1 parent 0c229bd commit fa25b5d

File tree

3 files changed

+30
-0
lines changed

3 files changed

+30
-0
lines changed

docs/antora.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
name: clojurephant-tooling
2+
version: true
3+
nav:
4+
- modules/ROOT/nav.adoc
5+
asciidoc:
6+
attributes:
7+
clojurephant-version: "0.7.0"
8+
clojurephant-tooling-version: "x.y.z"

docs/modules/ROOT/nav.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
* xref:index.adoc[]
2+
* link:https://cljdoc.org/d/dev.clojurephant/clojurephant-tooling/CURRENT[API Reference]

docs/modules/ROOT/pages/index.adoc

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
= Introduction
2+
3+
The Clojurephant Tooling API (link:https://github.com/clojurephant/clojurephant-tooling[GitHub Repo]) is a sibling project to link:https://github.com/clojurephant/clojurephant[Clojurephant], the Gradle plugin providing support for Clojure and ClojureScript builds.
4+
5+
This library is meant for use from a Clojure REPL to interact with a Gradle project using Clojurephant.
6+
7+
CAUTION: The features and API should not be considered stable until 1.0.0.
8+
9+
== Features
10+
11+
* General Clojure wrapper for link:https://docs.gradle.org/current/userguide/third_party_integration.html[Gradle's Tooling API]
12+
* Access to Clojurephant's Gradle configuration from the REPL
13+
* Compile ClojureScript builds (including in watch mode)
14+
* Start ClojureScript REPLs based on:
15+
** Figwheel Main - with full hot code reloading
16+
** Figwheel REPL - for a more tranditional workflow, evaluating forms
17+
18+
== API Documentation
19+
20+
See API reference on link:https://cljdoc.org/d/dev.clojurephant/clojurephant-tooling/CURRENT[cljdoc].

0 commit comments

Comments
 (0)