Fork me on GitHub
#yada
<
2016-08-15
>
bhagany03:08:37

I just finished reading the manual from top to bottom. Writing such comprehensive documentation is hard work, so I just wanted to say, thank you for your attention to detail, and I'm eager for the parts that are yet to be filled in.

tbrooke15:08:29

@malcolmsparks: unrelated to yada - but the new docs look great and I familiar with Asciidoc and wouldlike to use similar format for unrelated project - are there open source stylesheets, workflow suggestions etc.

malcolmsparks15:08:39

@tbrooke: we've mostly gone with the defaults and stylesheets here: https://github.com/asciidoctor/asciidoctorj

malcolmsparks15:08:01

there are lots of open-source themes and options available

malcolmsparks16:08:05

it really was quite straightforward to generate the book. Here's the code I used:

malcolmsparks16:08:49

served of course with a yada resource:

malcolmsparks16:08:52

The :state value of the yada ctx here isn't yada, I'm injecting in using a custom interceptor

malcolmsparks16:08:42

In our website we keep all our application state in a tree which can be deref'd - it's just like Om's app-state or Reagent's ratom, but contains the entire state of the observeable universe (at least as far as our server is concerned) - we deref it on every request - means that for the lifetime of the request/response, the universe is frozen and consistent.

malcolmsparks16:08:36

but anyway, AsciiDoc is very easy. Here's the book.adoc file

malcolmsparks16:08:28

With asciidoc, includes are built in. Cross-references are super easy too, plus tables, code snippets, etc.

malcolmsparks16:08:47

It is so much more consistent and powerful than markdown, imho

malcolmsparks16:08:00

much better suited to writing a pile of technical documentation

tbrooke18:08:44

@malcolmsparks: Wow Thanks and of course the html has to be served as a resource