Docs Progress

33 views
Skip to first unread message

Boris Kourtoukov

unread,
Jun 25, 2014, 1:02:23 AM6/25/14
to enf...@googlegroups.com
Hi Creighton,

A bit too long to tweet :)

http://boriskourt.github.io/kioo-docs/ the latest is up, I think I added most of the functionality we would need.
Your input is very welcome at this stage as I am still not very good with CLJS.

Here is the main file: https://github.com/BorisKourt/kioo-docs/blob/master/src/cljs/kioo/docs/site.cljs
And here is the data atom: https://github.com/BorisKourt/kioo-docs/blob/master/src/cljs/kioo/docs/post-data.cljs

I had to store the full text 'doc' entries as .txt instead of .md as I couldn't get .md files with cljs-ajax.
I also don't even know if this is the best way to store the entries.

The process of adding an entry is: Add a map to the atom with a few short parameters. Then add a .txt file to ./pages/ with the markdown. Then everything should work.

Currently if you click on the Getting started with om and getting started with reagent links it will open an (unfinished css) overlay with the parsed markdown content. (Which has some entity encoding issues :( )

I know there are a bunch of 'empty' defsnippet statements Ill try to transfer more of the template content into CLJS.

Anyway, hope this is a good start, feel free to clone and edit. I think you have full access.

-Boris


ckirkendall

unread,
Jun 27, 2014, 12:07:04 PM6/27/14
to enf...@googlegroups.com
Boris,
Thank you so much for pushing forward on this.  I will get sometime next week to sit down and figure out better content.  I think the content should be in HTML and not markdown.  In particular I would love jsbin syntax highlighting on the code.  Right now we have help for working with om and reagent.  I would also add kioo core.  Kioo core can be used as standalone or with quiescent.  I need to work out a basic tutorial that is more complete than what we have.  I will start working on that.  Thank you again for doing all of this.  It really helps!

Creighton

Boris Kourtoukov

unread,
Jun 27, 2014, 1:07:10 PM6/27/14
to enf...@googlegroups.com
Alrighty, sounds good! Do give me a shout if/when there is something for me to expand on. Not sure what to tackle next on this while I wait.

As an aside:
The markdown-clj lib does add language specific classes to the code elements, so most JS based syntax highlighting should work fine.
If you do go the HTML route for content, do you see it being via (def)snippets/pages or still using AJAX?

I haven't seen Kioo core used as standalone yet, can't wait to see your example of it.

Boris

ckirkendall

unread,
Jun 28, 2014, 8:49:06 AM6/28/14
to enf...@googlegroups.com
I feel like all content should come in as defsnippet and deftemplates.  We can mix in the syntax highlighting by hooking into the wrap transform I am working on now.  It will be a good example of how to use wrapping.  One nice thing is that by viewing the source you should be able to pull the HTML version of the tutorial without having to do a lot of work.  

Creighton

Boris Kourtoukov

unread,
Jun 28, 2014, 11:40:51 AM6/28/14
to enf...@googlegroups.com
Sounds good, looking forward to seeing wrapping in action.

ckirkendall

unread,
Jun 28, 2014, 1:33:22 PM6/28/14
to enf...@googlegroups.com
Boris,cc
I pushed up the lifecycle transform.  This allows us to access all the lifecycle methods in react.  



Creighton

Boris Kourtoukov

unread,
Jun 28, 2014, 4:40:56 PM6/28/14
to enf...@googlegroups.com
Nice! And this is directly for Kioo Core right?
Reply all
Reply to author
Forward
0 new messages