Betterdocs.

Refer to docs

We use gh-pages and Jekyll for demo web ui.

Installation instructions.

Step 1 Configuration.

Update the configuration in application.properties

Step 2 Run.

BetterDocs is built by SBT

$ sbt

$ > project core

$ > run

Then select com.betterdocs.spark.CreateIndexJob to run the Spark job that creates index which can be digested by elasticsearch.

Step 3 Upload to elastic Search.

Please install elasticsearch from here. Once the elasticsearch service is running "locally". Run,

$ bin/upload_to_es.sh

This will upload the index generated by the job in previous step to elastic search server.

Betterdocs Intellij idea plugin

Installation instructions.

Step 1 Download and install Intellij Idea.

If you already have intellij installed, you can skip this step.

Step 2 package the plugin

sbt -Didea.lib="$IDEA_HOME/lib" package

Step 2 Install plugin from disk

Once jar is built goto Settings -> Plugins -> Install from disk -> Select the plugin jar built in previous step-> Restart(to use plugin)