Tool creating an asciidoctor project

Previous Topic Next Topic
 
classic Classic list List threaded Threaded
22 messages Options
12
Reply | Threaded
Open this post in threaded view
|

Tool creating an asciidoctor project

ch007m
Hi,

Is there a tool like jekyll that we can use to create an asciidoctor project including GuardFile, css, pictures ?

Regards,

Charles
Charles Moulliard
Apache Committer / Technologist Evangelist / Blogger / MiddleWare Specialist
Twitter : @cmoulliard
Reply | Threaded
Open this post in threaded view
|

Re: Tool creating an asciidoctor project

LightGuardjp
Jekyll is a blog / static site generator. Technically anything using tilt (Jekyll, middleman, etc) will let you do that. 

Are you looking to create a website with your asciidoc output or something else?


On Wed, Oct 2, 2013 at 10:47 AM, Charles [via Asciidoctor :: Discussion] <[hidden email]> wrote:
Hi,

Is there a tool like jekyll that we can use to create an asciidoctor project including GuardFile, css, pictures ?

Regards,

Charles


If you reply to this email, your message will be added to the discussion below:
http://discuss.asciidoctor.org/Tool-creating-an-asciidoctor-project-tp677.html
To start a new topic under Asciidoctor :: Discussion, email [hidden email]
To unsubscribe from Asciidoctor :: Discussion, click here.
NAML



--
Reply | Threaded
Open this post in threaded view
|

Re: Tool creating an asciidoctor project

ch007m
In fact, I'm interested to have the following thing. Like what we can do with maven archetype, it could be interesting to have a skeleton of a asciidoctor project (containing a dummy asciidoctor file - aka template with syntax definition, guard file - to be able to use live view, css - for style rendering of blocks, icons, ...), with all what is required to be able to develop content, documentation, ... and import it after in IntelliJ, Eclipse, ...

Remark : Integration of asciidoctor with jekyll, awestruct is something else. Sorry to confuse you with my previous email/question
Charles Moulliard
Apache Committer / Technologist Evangelist / Blogger / MiddleWare Specialist
Twitter : @cmoulliard
Reply | Threaded
Open this post in threaded view
|

Re: Tool creating an asciidoctor project

mojavelinux
Administrator
Charles,

Currently there is no such tool, but it's certainly a good idea.

If you were planning to use Maven to do the build, you could consider making a Maven archetype. Gradle also has a facility for setting up a project foundation. Another option is Forge.

If you want to build with the asciidoctor command alone, or a custom Ruby script, then I might suggest creating a Ruby or shell script to do the job.

The first step, though, is to have a model project...what you want the final project to look like. We're in the process of establishing a recommended layout, and this could help. Perhaps toss a git repository onto GitHub and start laying it out. We can then discuss and send pull requests and eventually we'll get to something we all think is reasonable. From there, we can build out a project creator. Sound reasonable?

-Dan


On Thu, Oct 3, 2013 at 12:53 AM, ch007m [via Asciidoctor :: Discussion] <[hidden email]> wrote:
In fact, I'm interested to have the following thing. Like what we can do with maven archetype, it could be interesting to have a skeleton of a asciidoctor project (containing a dummy asciidoctor file - aka template with syntax definition, guard file - to be able to use live view, css - for style rendering of blocks, icons, ...), with all what is required to be able to develop content, documentation, ... and import it after in IntelliJ, Eclipse, ...

Remark : Integration of asciidoctor with jekyll, awestruct is something else. Sorry to confuse you with my previous email/question


If you reply to this email, your message will be added to the discussion below:
http://discuss.asciidoctor.org/Tool-creating-an-asciidoctor-project-tp677p680.html
To start a new topic under Asciidoctor :: Discussion, email [hidden email]
To unsubscribe from Asciidoctor :: Discussion, click here.
NAML



--
Reply | Threaded
Open this post in threaded view
|

Re: Tool creating an asciidoctor project

mojavelinux
Administrator
In reply to this post by ch007m
When I first read the title of this e-mail, I was thinking, "What is an Asciidoctor project?" I never really thought about it that way, but it does make sense.

Though, part of the reason it sounded foreign to me is that, up to this point, all my Asciidoctor projects are actually Awestruct projects...with the goal of making a website. But there are certainly times when you'll want to create just a documentation project. I suppose that makes it an Asciidoctor project :)

-Dan


On Sat, Oct 5, 2013 at 1:37 AM, Dan Allen <[hidden email]> wrote:
Charles,

Currently there is no such tool, but it's certainly a good idea.

If you were planning to use Maven to do the build, you could consider making a Maven archetype. Gradle also has a facility for setting up a project foundation. Another option is Forge.

If you want to build with the asciidoctor command alone, or a custom Ruby script, then I might suggest creating a Ruby or shell script to do the job.

The first step, though, is to have a model project...what you want the final project to look like. We're in the process of establishing a recommended layout, and this could help. Perhaps toss a git repository onto GitHub and start laying it out. We can then discuss and send pull requests and eventually we'll get to something we all think is reasonable. From there, we can build out a project creator. Sound reasonable?

-Dan


On Thu, Oct 3, 2013 at 12:53 AM, ch007m [via Asciidoctor :: Discussion] <[hidden email]> wrote:
In fact, I'm interested to have the following thing. Like what we can do with maven archetype, it could be interesting to have a skeleton of a asciidoctor project (containing a dummy asciidoctor file - aka template with syntax definition, guard file - to be able to use live view, css - for style rendering of blocks, icons, ...), with all what is required to be able to develop content, documentation, ... and import it after in IntelliJ, Eclipse, ...

Remark : Integration of asciidoctor with jekyll, awestruct is something else. Sorry to confuse you with my previous email/question


If you reply to this email, your message will be added to the discussion below:
http://discuss.asciidoctor.org/Tool-creating-an-asciidoctor-project-tp677p680.html
To start a new topic under Asciidoctor :: Discussion, email [hidden email]
To unsubscribe from Asciidoctor :: Discussion, click here.
NAML



--



--
Reply | Threaded
Open this post in threaded view
|

Re: Tool creating an asciidoctor project

mojavelinux
Administrator
In reply to this post by ch007m
I found a Ruby library that provides a framework for creating new projects.


This is sort of like a Maven archetype, but more scriptable. If you want to go the Ruby route, this might be an option.

-Dan


On Sat, Oct 5, 2013 at 1:37 AM, Dan Allen <[hidden email]> wrote:
Charles,

Currently there is no such tool, but it's certainly a good idea.

If you were planning to use Maven to do the build, you could consider making a Maven archetype. Gradle also has a facility for setting up a project foundation. Another option is Forge.

If you want to build with the asciidoctor command alone, or a custom Ruby script, then I might suggest creating a Ruby or shell script to do the job.

The first step, though, is to have a model project...what you want the final project to look like. We're in the process of establishing a recommended layout, and this could help. Perhaps toss a git repository onto GitHub and start laying it out. We can then discuss and send pull requests and eventually we'll get to something we all think is reasonable. From there, we can build out a project creator. Sound reasonable?

-Dan


On Thu, Oct 3, 2013 at 12:53 AM, ch007m [via Asciidoctor :: Discussion] <[hidden email]> wrote:
In fact, I'm interested to have the following thing. Like what we can do with maven archetype, it could be interesting to have a skeleton of a asciidoctor project (containing a dummy asciidoctor file - aka template with syntax definition, guard file - to be able to use live view, css - for style rendering of blocks, icons, ...), with all what is required to be able to develop content, documentation, ... and import it after in IntelliJ, Eclipse, ...

Remark : Integration of asciidoctor with jekyll, awestruct is something else. Sorry to confuse you with my previous email/question


If you reply to this email, your message will be added to the discussion below:
http://discuss.asciidoctor.org/Tool-creating-an-asciidoctor-project-tp677p680.html
To start a new topic under Asciidoctor :: Discussion, email [hidden email]
To unsubscribe from Asciidoctor :: Discussion, click here.
NAML



--



--
Reply | Threaded
Open this post in threaded view
|

Re: Tool creating an asciidoctor project

ch007m
In reply to this post by mojavelinux
This is exactly what I'm looking for. Asciidoctor project should help us to design/develop our documentation without the help of an external third party tool like awestruct / jekyll
Charles Moulliard
Apache Committer / Technologist Evangelist / Blogger / MiddleWare Specialist
Twitter : @cmoulliard
Reply | Threaded
Open this post in threaded view
|

Re: Tool creating an asciidoctor project

ch007m
In reply to this post by mojavelinux
Is a ruby gen framework the way to go ....
 As most of the users are maven guys, that documentation projects will be included into a maven project, maven plugin should be the way to go ?
Charles Moulliard
Apache Committer / Technologist Evangelist / Blogger / MiddleWare Specialist
Twitter : @cmoulliard
Reply | Threaded
Open this post in threaded view
|

Re: Tool creating an asciidoctor project

mojavelinux
Administrator

Then I'd say the Maven plugin, and an archetype that sets it up, is the way to go. You may want to evaluate the Gradle plugin as well, since Gradle will provide more flexibility.

There are lots of examples of both in the wild.

-Dan

Reply | Threaded
Open this post in threaded view
|

Re: Tool creating an asciidoctor project

aalmiray
Another would be to create a Lazybones template (https://github.com/pledbrook/lazybones). Though Maven already supports archetypes I'd say it's easier and faster to create and deploy Lazybones templates. And though lazybones relies on Groovy and it's Gradle friendly it does not stop it from boostrapping non-gradle builds.

Cheers,
Andres
Reply | Threaded
Open this post in threaded view
|

Re: Tool creating an asciidoctor project

mojavelinux
Administrator

Andres,

Thanks for the tip! That looks like exactly what we need here. I like that it doesn't try to overcomplicate the problem. Resources and a script. With those two, you can build pretty much anything.

Lazybones would be useful for Awestruct site templates as well. I'll definitely be using that tool in the near future.

-Dan

On Oct 10, 2013 12:43 AM, "aalmiray [via Asciidoctor :: Discussion]" <[hidden email]> wrote:
Another would be to create a Lazybones template (https://github.com/pledbrook/lazybones). Though Maven already supports archetypes I'd say it's easier and faster to create and deploy Lazybones templates. And though lazybones relies on Groovy and it's Gradle friendly it does not stop it from boostrapping non-gradle builds.

Cheers,
Andres


If you reply to this email, your message will be added to the discussion below:
http://discuss.asciidoctor.org/Tool-creating-an-asciidoctor-project-tp677p775.html
To start a new topic under Asciidoctor :: Discussion, email [hidden email]
To unsubscribe from Asciidoctor :: Discussion, click here.
NAML
Reply | Threaded
Open this post in threaded view
|

Re: Tool creating an asciidoctor project

ch007m
As a documentation project could be more complex and include also exercises for students (java, scala, ruby, ...) maven is perhaps a better approach with a 'command line tool' to create a new project, render, module

So typically, we could imagine to design a command line tool supporting to create a skeleton, render content, watch content, ...

--> asciidoctor-tool `command``options`

where command could be :  create, render, upgrade, watch, site or build and options will depend of the command use

- create `name of the project``project_type` (where project_type could be blog, documentation, training, ... and will create a different project structure as a blog = blog directory + static pages (index.html, menu.html) + menu, documentation = collection of directories/modules + index.html page, web site = collection of directories + index.html + menu.html + search.html, training = documentation + dir containing java classes/resources)
- upgrade `name of the project`(idea is to upgrade a project from asciidoctor 0.1 to 0.2)
- render `backend type` (where attributes and other asciidoctor parameters will be defined in YAML, ... config file)
- watch (= watch files modifications followed by render + LiveReload)
- build or site (generate content of the project = HTML5 + resources (images, ...) and zip it, build it
Charles Moulliard
Apache Committer / Technologist Evangelist / Blogger / MiddleWare Specialist
Twitter : @cmoulliard
Jmm
Reply | Threaded
Open this post in threaded view
|

Re: Tool creating an asciidoctor project

Jmm
I don't know if this is contributing to the idea... (I find many things I like/am looking for in ch007m's proposal)

I am currently working on a Maven Archetype that helps to create a standalone Mavenized document pipeline. I hope to be able to show something to the group soon.

The proposal is a Maven setup that will/can generate from Asciidoc sources PDFs (I know I am old school) or HTML pages. I also want to include UML drawing generation with UMLet as an example.

The idea is to provide a tool aimed at

* people that are less technical skilled to easily start writing a document. The pom can later evolve into a full featured project. A project generally starts with a spec, right ?, that later evolves into code and a technical product documentation.

* people wanting to evaluate or learn Asciidoc quickly with easily installed tooling (or tools they know) and serve as examples.

At least this archetype would fit my needs here at work and would be a key tool in evangelizing Asciidoc in my company.

Jmm
Reply | Threaded
Open this post in threaded view
|

Re: Tool creating an asciidoctor project

ch007m
I have also created a maven project + archetype to setup skeleton of asciidoctor project including also grunt to watch modification and upload modifications using livereload


On Wed, Nov 27, 2013 at 1:11 PM, Jmm [via Asciidoctor :: Discussion] <[hidden email]> wrote:
I don't know if this is contributing to the idea... (I find many things I like/am looking for in ch007m's proposal)

I am currently working on a Maven Archetype that helps to create a standalone Mavenized document pipeline. I hope to be able to show something to the group soon.

The proposal is a Maven setup that will/can generate from Asciidoc sources PDFs (I know I am old school) or HTML pages. I also want to include UML drawing generation with UMLet as an example.

The idea is to provide a tool aimed at

* people that are less technical skilled to easily start writing a document. The pom can later evolve into a full featured project. A project generally starts with a spec, right ?, that later evolves into code and a technical product documentation.

* people wanting to evaluate or learn Asciidoc quickly with easily installed tooling (or tools they know) and serve as examples.

At least this archetype would fit my needs here at work and would be a key tool in evangelizing Asciidoc in my company.

Jmm


If you reply to this email, your message will be added to the discussion below:
http://discuss.asciidoctor.org/Tool-creating-an-asciidoctor-project-tp677p1136.html
To unsubscribe from Tool creating an asciidoctor project, click here.
NAML



--
Charles Moulliard
Apache Committer / Architect @RedHat
Twitter : @cmoulliard | Blog :  http://cmoulliard.github.io

Charles Moulliard
Apache Committer / Technologist Evangelist / Blogger / MiddleWare Specialist
Twitter : @cmoulliard
Jmm
Reply | Threaded
Open this post in threaded view
|

Re: Tool creating an asciidoctor project

Jmm

Is this archetype available ?

Sorry but I didn't understand your sentense from the word "grunt". Could you give more details ? Some words make me thing that these are interesting features.

Jmm

Not sent from my PC

Le 27 nov. 2013 16:10, "ch007m [via Asciidoctor :: Discussion]" <[hidden email]> a écrit :
I have also created a maven project + archetype to setup skeleton of asciidoctor project including also grunt to watch modification and upload modifications using livereload


On Wed, Nov 27, 2013 at 1:11 PM, Jmm [via Asciidoctor :: Discussion] <[hidden email]> wrote:
I don't know if this is contributing to the idea... (I find many things I like/am looking for in ch007m's proposal)

I am currently working on a Maven Archetype that helps to create a standalone Mavenized document pipeline. I hope to be able to show something to the group soon.

The proposal is a Maven setup that will/can generate from Asciidoc sources PDFs (I know I am old school) or HTML pages. I also want to include UML drawing generation with UMLet as an example.

The idea is to provide a tool aimed at

* people that are less technical skilled to easily start writing a document. The pom can later evolve into a full featured project. A project generally starts with a spec, right ?, that later evolves into code and a technical product documentation.

* people wanting to evaluate or learn Asciidoc quickly with easily installed tooling (or tools they know) and serve as examples.

At least this archetype would fit my needs here at work and would be a key tool in evangelizing Asciidoc in my company.

Jmm


If you reply to this email, your message will be added to the discussion below:
http://discuss.asciidoctor.org/Tool-creating-an-asciidoctor-project-tp677p1136.html
To unsubscribe from Tool creating an asciidoctor project, click here.
NAML



--
Charles Moulliard
Apache Committer / Architect @RedHat
Twitter : @cmoulliard | Blog :  http://cmoulliard.github.io




If you reply to this email, your message will be added to the discussion below:
http://discuss.asciidoctor.org/Tool-creating-an-asciidoctor-project-tp677p1139.html
To start a new topic under Asciidoctor :: Discussion, email [hidden email]
To unsubscribe from Asciidoctor :: Discussion, click here.
NAML
Reply | Threaded
Open this post in threaded view
|

Re: Tool creating an asciidoctor project

ch007m
- Archetype is not yet available but I plan' to donate the code to asciidoctor as a subproject asciidoctor-hyla
- I will now work to create a command line tool to be able to create, watch and render a project (using java - Karaf Shell
- Grunt is a javascript task runner that more and more projects use to render less, sass, ..., watch, lievreload files (http://gruntjs.com/)


On Wed, Nov 27, 2013 at 4:31 PM, Jmm [via Asciidoctor :: Discussion] <[hidden email]> wrote:

Is this archetype available ?

Sorry but I didn't understand your sentense from the word "grunt". Could you give more details ? Some words make me thing that these are interesting features.

Jmm

Not sent from my PC

Le 27 nov. 2013 16:10, "ch007m [via Asciidoctor :: Discussion]" <[hidden email]> a écrit :
I have also created a maven project + archetype to setup skeleton of asciidoctor project including also grunt to watch modification and upload modifications using livereload


On Wed, Nov 27, 2013 at 1:11 PM, Jmm [via Asciidoctor :: Discussion] <[hidden email]> wrote:
I don't know if this is contributing to the idea... (I find many things I like/am looking for in ch007m's proposal)

I am currently working on a Maven Archetype that helps to create a standalone Mavenized document pipeline. I hope to be able to show something to the group soon.

The proposal is a Maven setup that will/can generate from Asciidoc sources PDFs (I know I am old school) or HTML pages. I also want to include UML drawing generation with UMLet as an example.

The idea is to provide a tool aimed at

* people that are less technical skilled to easily start writing a document. The pom can later evolve into a full featured project. A project generally starts with a spec, right ?, that later evolves into code and a technical product documentation.

* people wanting to evaluate or learn Asciidoc quickly with easily installed tooling (or tools they know) and serve as examples.

At least this archetype would fit my needs here at work and would be a key tool in evangelizing Asciidoc in my company.

Jmm


If you reply to this email, your message will be added to the discussion below:
http://discuss.asciidoctor.org/Tool-creating-an-asciidoctor-project-tp677p1136.html
To unsubscribe from Tool creating an asciidoctor project, click here.
NAML



--
Charles Moulliard
Apache Committer / Architect @RedHat
Twitter : @cmoulliard | Blog :  http://cmoulliard.github.io




If you reply to this email, your message will be added to the discussion below:
http://discuss.asciidoctor.org/Tool-creating-an-asciidoctor-project-tp677p1139.html
To start a new topic under Asciidoctor :: Discussion, email [hidden email]
To unsubscribe from Asciidoctor :: Discussion, click here.
NAML



If you reply to this email, your message will be added to the discussion below:
http://discuss.asciidoctor.org/Tool-creating-an-asciidoctor-project-tp677p1140.html
To unsubscribe from Tool creating an asciidoctor project, click here.
NAML



--
Charles Moulliard
Apache Committer / Architect @RedHat
Twitter : @cmoulliard | Blog :  http://cmoulliard.github.io

Charles Moulliard
Apache Committer / Technologist Evangelist / Blogger / MiddleWare Specialist
Twitter : @cmoulliard
Jmm
Reply | Threaded
Open this post in threaded view
|

Re: Tool creating an asciidoctor project

Jmm

Thank you for the clarification. I am looking forward to see your work as it answers an important need.

Jmm

Not sent from my PC

Le 27 nov. 2013 19:00, "ch007m [via Asciidoctor :: Discussion]" <[hidden email]> a écrit :
- Archetype is not yet available but I plan' to donate the code to asciidoctor as a subproject asciidoctor-hyla
- I will now work to create a command line tool to be able to create, watch and render a project (using java - Karaf Shell
- Grunt is a javascript task runner that more and more projects use to render less, sass, ..., watch, lievreload files (http://gruntjs.com/)


On Wed, Nov 27, 2013 at 4:31 PM, Jmm [via Asciidoctor :: Discussion] <[hidden email]> wrote:

Is this archetype available ?

Sorry but I didn't understand your sentense from the word "grunt". Could you give more details ? Some words make me thing that these are interesting features.

Jmm

Not sent from my PC

Le 27 nov. 2013 16:10, "ch007m [via Asciidoctor :: Discussion]" <[hidden email]> a écrit :
I have also created a maven project + archetype to setup skeleton of asciidoctor project including also grunt to watch modification and upload modifications using livereload


On Wed, Nov 27, 2013 at 1:11 PM, Jmm [via Asciidoctor :: Discussion] <[hidden email]> wrote:
I don't know if this is contributing to the idea... (I find many things I like/am looking for in ch007m's proposal)

I am currently working on a Maven Archetype that helps to create a standalone Mavenized document pipeline. I hope to be able to show something to the group soon.

The proposal is a Maven setup that will/can generate from Asciidoc sources PDFs (I know I am old school) or HTML pages. I also want to include UML drawing generation with UMLet as an example.

The idea is to provide a tool aimed at

* people that are less technical skilled to easily start writing a document. The pom can later evolve into a full featured project. A project generally starts with a spec, right ?, that later evolves into code and a technical product documentation.

* people wanting to evaluate or learn Asciidoc quickly with easily installed tooling (or tools they know) and serve as examples.

At least this archetype would fit my needs here at work and would be a key tool in evangelizing Asciidoc in my company.

Jmm


If you reply to this email, your message will be added to the discussion below:
http://discuss.asciidoctor.org/Tool-creating-an-asciidoctor-project-tp677p1136.html
To unsubscribe from Tool creating an asciidoctor project, click here.
NAML



--
Charles Moulliard
Apache Committer / Architect @RedHat
Twitter : @cmoulliard | Blog :  http://cmoulliard.github.io




If you reply to this email, your message will be added to the discussion below:
http://discuss.asciidoctor.org/Tool-creating-an-asciidoctor-project-tp677p1139.html
To start a new topic under Asciidoctor :: Discussion, email [hidden email]
To unsubscribe from Asciidoctor :: Discussion, click here.
NAML



If you reply to this email, your message will be added to the discussion below:
http://discuss.asciidoctor.org/Tool-creating-an-asciidoctor-project-tp677p1140.html
To unsubscribe from Tool creating an asciidoctor project, click here.
NAML



--
Charles Moulliard
Apache Committer / Architect @RedHat
Twitter : @cmoulliard | Blog :  http://cmoulliard.github.io




If you reply to this email, your message will be added to the discussion below:
http://discuss.asciidoctor.org/Tool-creating-an-asciidoctor-project-tp677p1143.html
To start a new topic under Asciidoctor :: Discussion, email [hidden email]
To unsubscribe from Asciidoctor :: Discussion, click here.
NAML
Reply | Threaded
Open this post in threaded view
|

Re: Tool creating an asciidoctor project

mojavelinux
Administrator
As I am too! This is a great initiative to help people (and ourselves) get started with documentation projects.

We can definitely host a project in Asciidoctor that produces a Maven archetype. I like where Charles is going with the livereload build integration as well. If it makes sense to have everything hosted in the hyla repository, that works too. I'd say we should choose whatever makes it easiest for the new user.

Charles and Jean Marc, I can make you both admins on the hyla and, if there is one, the Maven achetype repo as well. Then, you guys can take over from there. Just let me know when you have something you want to import.

Cheers!

-Dan


On Thu, Nov 28, 2013 at 12:46 AM, Jmm [via Asciidoctor :: Discussion] <[hidden email]> wrote:

Thank you for the clarification. I am looking forward to see your work as it answers an important need.

Jmm

Not sent from my PC

Le 27 nov. 2013 19:00, "ch007m [via Asciidoctor :: Discussion]" <[hidden email]> a écrit :

- Archetype is not yet available but I plan' to donate the code to asciidoctor as a subproject asciidoctor-hyla
- I will now work to create a command line tool to be able to create, watch and render a project (using java - Karaf Shell
- Grunt is a javascript task runner that more and more projects use to render less, sass, ..., watch, lievreload files (http://gruntjs.com/)


On Wed, Nov 27, 2013 at 4:31 PM, Jmm [via Asciidoctor :: Discussion] <[hidden email]> wrote:

Is this archetype available ?

Sorry but I didn't understand your sentense from the word "grunt". Could you give more details ? Some words make me thing that these are interesting features.

Jmm

Not sent from my PC

Le 27 nov. 2013 16:10, "ch007m [via Asciidoctor :: Discussion]" <[hidden email]> a écrit :
I have also created a maven project + archetype to setup skeleton of asciidoctor project including also grunt to watch modification and upload modifications using livereload


On Wed, Nov 27, 2013 at 1:11 PM, Jmm [via Asciidoctor :: Discussion] <[hidden email]> wrote:
I don't know if this is contributing to the idea... (I find many things I like/am looking for in ch007m's proposal)

I am currently working on a Maven Archetype that helps to create a standalone Mavenized document pipeline. I hope to be able to show something to the group soon.

The proposal is a Maven setup that will/can generate from Asciidoc sources PDFs (I know I am old school) or HTML pages. I also want to include UML drawing generation with UMLet as an example.

The idea is to provide a tool aimed at

* people that are less technical skilled to easily start writing a document. The pom can later evolve into a full featured project. A project generally starts with a spec, right ?, that later evolves into code and a technical product documentation.

* people wanting to evaluate or learn Asciidoc quickly with easily installed tooling (or tools they know) and serve as examples.

At least this archetype would fit my needs here at work and would be a key tool in evangelizing Asciidoc in my company.

Jmm


If you reply to this email, your message will be added to the discussion below:
http://discuss.asciidoctor.org/Tool-creating-an-asciidoctor-project-tp677p1136.html
To unsubscribe from Tool creating an asciidoctor project, click here.
NAML



--
Charles Moulliard
Apache Committer / Architect @RedHat
Twitter : @cmoulliard | Blog :  http://cmoulliard.github.io




If you reply to this email, your message will be added to the discussion below:
http://discuss.asciidoctor.org/Tool-creating-an-asciidoctor-project-tp677p1139.html
To start a new topic under Asciidoctor :: Discussion, email [hidden email]
To unsubscribe from Asciidoctor :: Discussion, click here.
NAML



If you reply to this email, your message will be added to the discussion below:
http://discuss.asciidoctor.org/Tool-creating-an-asciidoctor-project-tp677p1140.html
To unsubscribe from Tool creating an asciidoctor project, click here.
NAML



--
Charles Moulliard
Apache Committer / Architect @RedHat
Twitter : @cmoulliard | Blog :  http://cmoulliard.github.io




If you reply to this email, your message will be added to the discussion below:
http://discuss.asciidoctor.org/Tool-creating-an-asciidoctor-project-tp677p1143.html
To start a new topic under Asciidoctor :: Discussion, email [hidden email]
To unsubscribe from Asciidoctor :: Discussion, click here.
NAML



If you reply to this email, your message will be added to the discussion below:
http://discuss.asciidoctor.org/Tool-creating-an-asciidoctor-project-tp677p1150.html
To start a new topic under Asciidoctor :: Discussion, email [hidden email]
To unsubscribe from Asciidoctor :: Discussion, click here.
NAML



--
Reply | Threaded
Open this post in threaded view
|

Re: Tool creating an asciidoctor project

ch007m
FYI. I already have a skeleton of Hyla project. Until now, I have done 2 things as project continue to evolve since its creation 2 weeks ago

1) Maven Project

This project contains 3 maven modules : 
- Parent (= parent pom where versions, dependencies, plugins used are defined)
- Common (= module containing images, css, javascript which are common). I'm not sure that I will continue to maintain it like that as every project could have a different collection of css, js, ... resources and until now it contains what I'm using for my project. So this module should become deprecated ....
- Tooling (= maven archetype which allow to create an asciidoctor project with directories (module-a, module-b) containing dummy asciidoctor files but also java code in a separate directory structure (src/main/main ...). The project created allow to watch files modified to generate HTML5 files (using grunt - js task manager) like also creating a zip of generated files/code

As mentioned in another discussion, the idea behind the tool/archetype is to have the possibility, flexibility to create a skeleton of a project in order to build : blog (jekyll), web site (awestruct), documentation or training content. As I only support documentation/training content + code for the moment, the archetype resources available should be relocated in hyla or hosted in another asciidoctor project --> asciidoctor-templates/blog,web,documentation/training ... as the goal of hyla is just to provide the tooling required to create, watch, build. Make sense ?

As some users are not familiar with Maven and that it will not be used at all by all asciidoctor projects, the tool should also be able to create a simple file project structure or gem/ruby or gradle or ... whatever you prefer. This is not the case until now and should be part of the asciidoctor-templates project.

Creating a documentation/blog/website ... consume a lot of resources (time and efforts) like also watching, generating pdf, HTML5, slideshow, epub or build to distribute the result. This is why the finality of Hyla should also be to provide a command line tool with option like (create/new, watch, populate, generate, build ...) to help/simplify life of non coding guys like bloggers/trainers/ ... This is why I have started to create a Java Command Line Tool using Apache Felix Gogo/Runtime but as the technology has been developed more specifically for OSGI world, I arrive quickly to the conclusion that I will loose my time in that direction. 

2) Ruby Application

Since end of last week, I have started to (learn Ruby ;-) ) and created a Ruby Command Line client (using Ruby commander, ...) which is more easier to develop and maintain although it will be more difficult to integrate what maven offers (using maven archetype + properties to replace groupId/ArtifactId in the project structure = modules). I'm working on it but some commands can already been used : new, populate (create from one asciidoc file containing document structure (= TOC) a collection of directories (= level 1) with asciidoc files (= level 2),  and generate (asciidoc --> HTML5) ...

If what I have done interests the community, I can already push my code (thanks to the Hyla Frog) and share it to work together on it.

Regards,

Charles


On Tue, Dec 3, 2013 at 3:18 AM, mojavelinux [via Asciidoctor :: Discussion] <[hidden email]> wrote:
As I am too! This is a great initiative to help people (and ourselves) get started with documentation projects.

We can definitely host a project in Asciidoctor that produces a Maven archetype. I like where Charles is going with the livereload build integration as well. If it makes sense to have everything hosted in the hyla repository, that works too. I'd say we should choose whatever makes it easiest for the new user.

Charles and Jean Marc, I can make you both admins on the hyla and, if there is one, the Maven achetype repo as well. Then, you guys can take over from there. Just let me know when you have something you want to import.

Cheers!

-Dan


On Thu, Nov 28, 2013 at 12:46 AM, Jmm [via Asciidoctor :: Discussion] <[hidden email]> wrote:

Thank you for the clarification. I am looking forward to see your work as it answers an important need.

Jmm

Not sent from my PC

Le 27 nov. 2013 19:00, "ch007m [via Asciidoctor :: Discussion]" <[hidden email]> a écrit :

- Archetype is not yet available but I plan' to donate the code to asciidoctor as a subproject asciidoctor-hyla
- I will now work to create a command line tool to be able to create, watch and render a project (using java - Karaf Shell
- Grunt is a javascript task runner that more and more projects use to render less, sass, ..., watch, lievreload files (http://gruntjs.com/)


On Wed, Nov 27, 2013 at 4:31 PM, Jmm [via Asciidoctor :: Discussion] <[hidden email]> wrote:

Is this archetype available ?

Sorry but I didn't understand your sentense from the word "grunt". Could you give more details ? Some words make me thing that these are interesting features.

Jmm

Not sent from my PC

Le 27 nov. 2013 16:10, "ch007m [via Asciidoctor :: Discussion]" <[hidden email]> a écrit :
I have also created a maven project + archetype to setup skeleton of asciidoctor project including also grunt to watch modification and upload modifications using livereload


On Wed, Nov 27, 2013 at 1:11 PM, Jmm [via Asciidoctor :: Discussion] <[hidden email]> wrote:
I don't know if this is contributing to the idea... (I find many things I like/am looking for in ch007m's proposal)

I am currently working on a Maven Archetype that helps to create a standalone Mavenized document pipeline. I hope to be able to show something to the group soon.

The proposal is a Maven setup that will/can generate from Asciidoc sources PDFs (I know I am old school) or HTML pages. I also want to include UML drawing generation with UMLet as an example.

The idea is to provide a tool aimed at

* people that are less technical skilled to easily start writing a document. The pom can later evolve into a full featured project. A project generally starts with a spec, right ?, that later evolves into code and a technical product documentation.

* people wanting to evaluate or learn Asciidoc quickly with easily installed tooling (or tools they know) and serve as examples.

At least this archetype would fit my needs here at work and would be a key tool in evangelizing Asciidoc in my company.

Jmm


If you reply to this email, your message will be added to the discussion below:
http://discuss.asciidoctor.org/Tool-creating-an-asciidoctor-project-tp677p1136.html
To unsubscribe from Tool creating an asciidoctor project, click here.
NAML



--
Charles Moulliard
Apache Committer / Architect @RedHat
Twitter : @cmoulliard | Blog :  http://cmoulliard.github.io




If you reply to this email, your message will be added to the discussion below:
http://discuss.asciidoctor.org/Tool-creating-an-asciidoctor-project-tp677p1139.html
To start a new topic under Asciidoctor :: Discussion, email [hidden email]
To unsubscribe from Asciidoctor :: Discussion, click here.
NAML



If you reply to this email, your message will be added to the discussion below:
http://discuss.asciidoctor.org/Tool-creating-an-asciidoctor-project-tp677p1140.html
To unsubscribe from Tool creating an asciidoctor project, click here.
NAML



--
Charles Moulliard
Apache Committer / Architect @RedHat
Twitter : @cmoulliard | Blog :  http://cmoulliard.github.io




If you reply to this email, your message will be added to the discussion below:
http://discuss.asciidoctor.org/Tool-creating-an-asciidoctor-project-tp677p1143.html
To start a new topic under Asciidoctor :: Discussion, email [hidden email]
To unsubscribe from Asciidoctor :: Discussion, click here.
NAML



If you reply to this email, your message will be added to the discussion below:
http://discuss.asciidoctor.org/Tool-creating-an-asciidoctor-project-tp677p1150.html
To start a new topic under Asciidoctor :: Discussion, email [hidden email]
To unsubscribe from Asciidoctor :: Discussion, click here.
NAML






If you reply to this email, your message will be added to the discussion below:
http://discuss.asciidoctor.org/Tool-creating-an-asciidoctor-project-tp677p1166.html
To unsubscribe from Tool creating an asciidoctor project, click here.
NAML



--
Charles Moulliard
Apache Committer / Architect @RedHat
Twitter : @cmoulliard | Blog :  http://cmoulliard.github.io

Charles Moulliard
Apache Committer / Technologist Evangelist / Blogger / MiddleWare Specialist
Twitter : @cmoulliard
Reply | Threaded
Open this post in threaded view
|

Re: Tool creating an asciidoctor project

asotobu
I think it is a really good initiative, and it is true what you pointed out about starting a blog, website, or even slides consumes a lot of time which could be automatized as you mention (and do). You have mentioned jekyl and awestruct, but I think it would be amazing to have jBake support too.

You have done a really nice work.

Alex.
12