search

vavr-io / vavr-docs

Source of https://docs.vavr.io
Other
10 stars 28 forks source link

Best practice for generating html5 with asciidoctor #4

Open danieldietrich opened 9 years ago

danieldietrich commented 9 years ago

See comments in pom

danieldietrich commented 9 years ago

We should take a look at this example:

https://github.com/asciidoctor/asciidoctor-maven-examples/tree/master/asciidoc-to-html-example

The difference to our project is, that in this example the docs are part of the main project. We have a separate project, which is ok. We can take a look, how resources are referenced there.

nousedaccount commented 9 years ago

I think we will get "our" best practice after we encounter real work. After i read the comment, main focus is about location of resources such as images, css etc. Also we can create guidelines to write docs about how we store our images etc.

danieldietrich commented 9 years ago

:+1:

Some instructions can walk into a README.md of the project