Real-time collaborative editor for Asciidoc files
You can try it online on OpenShift : {online-demo}
This project gives you the possibility to work on the same Asciidoc files with a team.
It’s based on Asciidoctor project thanks to AsciidoctorJ.
0.1.0-Alpha1 features
-
By default when you click on connect, you are a *reader* :
-
It means that you can see what happens on HTML5 preview but you can’t send any source version
-
-
When you add a name and click to Enable editor, you become a *writer* :
-
so you can update the asciidoc source in realtime and automatically view HTML 5 rendered :
-
each time you write something if you have clicked on Send On Change
-
each time you press "Ctrl+S" if you have clicked on Send On Ctrl+S button
-
-
-
You can patch your file with the latest asciidoc source:
-
if an other author send a version, you can click on Compute Diff button to see differences between your adoc file and the last adoc file
-
if the patch seems ok, click on Apply Patch and you adoc source will be up to date
-
-
Several people can work on the same doc
-
you can see the number of writers (people who send adoc file)
-
you can see the name of the last author
-
ypu can see the numbr of readers (people who don’t send an asciidoc source)
-
Important
|
This version is an early alpha version. For now all connected people work on the same and unique document. |
Changelog
You can read all changes between each release in the changelog file.
Roadmap
A lot of cool features are planned :) You can read all open and closed issues and milestones
Technology used
-
Asciidoctor project
-
AsciidoctorJ 0.1.4
-
-
Java EE 7
-
CDI 1.1
-
WebSocket 1.0
-
JSON-P 1.0
-
EJB 3.1
-
-
Web Client
-
AngularJS 1.0.8
-
Ace Editor
-
Bootstrap 3.0
-
-
Tests
-
JUnit 4.8
-
Arquillian 1.1.2
-
-
Java EE 7 Compliance App server
-
WildFly 8.0.0-Beta1
-
Install wWSmAD on your laptop
Important
|
Prerequisites
|
-
First you need to deploy the Asciidoctor module into your WildFly server
-
Start wildfly :
$JBOSS_HOME/bin/standalone.sh
-
Build the WAR and test it into WildFly AS with maven/arquillian :
-
if the environement variable $JBOSS_HOME is set :
mvn clean package -Pwildfly-managed-arquillian
-
if you haven’t set the $JBOSS_HOME env variable :
mvn clean package -Pwildfly-managed-arquillian -DserverRoot=<path_to_your_server>
-
-
Deploy the app automatically with maven :
mvn wildfly:deploy -Dmaven.test.skip=true
-
Launch your browser and enjoy :)