News for hackers. Stuff that matters.
Re:Daux.io, a simple documentation generator by RyanZAG on Sunday July 14, 2013 @02:26PM (#6041652)
"You must use the .md file extension for your files. Also, you must use underscores instead of spaces."

Why? Are we still using MSDOS or something?

Re:Daux.io, a simple documentation generator by martin-adams on Sunday July 14, 2013 @02:54PM (#6041760)
There's probably no technical reason why other than design choice. It may be related to cleaner URLs omitting the %20 encoding.

However, hyphens would probably have been a better choice for URLs as Google treats them as individual words as opposed to one long keyword.

Re:Daux.io, a simple documentation generator by exceptione on Sunday July 14, 2013 @05:03PM (#6042230)
Also, hyphens save us an additional <shift>-key press. Hardly on topic, but my advise is to require underscores only when there is absolutely no alternative. Which is almost never the case.
Re:Daux.io, a simple documentation generator by justinwars on Sunday July 14, 2013 @11:49PM (#6043609)
The forced .md and underscores was mostly for speed of development on the first version of Daux. I agree it is a bit arbitrary and I plan on making the requirements a bit less strict in the future.
Re:Daux.io, a simple documentation generator by ciokan on Sunday July 14, 2013 @05:55PM (#6042407)
https://github.com/justinwalsh/daux.io/blob/master/index.php Seriously. Pick a template engine at least. They're around for quite some time.

PHP & Node? Pick one. Don't make it a pain to even install.

Re:Daux.io, a simple documentation generator by gramsey on Sunday July 14, 2013 @07:27PM (#6042690)
> PHP

> Pick a template engine at least.

There's a great one for PHP, it's called PHP. https://news.ycombinator.com/item?id=3821125

Re:Daux.io, a simple documentation generator by justinwars on Sunday July 14, 2013 @11:53PM (#6043617)
I agree I should have used a template engine. I wrote most of this with the idea that it would be a proof of concept but ended up turning into something I felt others would still benefit from. It's still simple enough to get around the code without a template engine, but I would love to refactor one in.
Re:Daux.io, a simple documentation generator by sciurus on Sunday July 14, 2013 @04:44PM (#6042169)
The feature "No Build Step" translates to "require your webserver to run PHP to render your documentation every time it's accessed".
Re:Daux.io, a simple documentation generator by justinwars on Sunday July 14, 2013 @11:55PM (#6043628)
This is completely true, and I started a Github issue to create an optional build script to generate a static set of files that could be deployed to S3, Github Pages or something similar. https://github.com/justinwalsh/daux.io/issues/6
Re:Daux.io, a simple documentation generator by mholt on Sunday July 14, 2013 @01:50PM (#6041530)
Way cool. Not sure I'm a fan of the syntax-highlighted code snippets to the right and in black text on the dark blue background though. Might like to see it closer to the content, and with more contrast.
Re:Daux.io, a simple documentation generator by justinwars on Monday July 15, 2013 @12:05AM (#6043654)
If your not a fan of the code floating, that can be disabled. We are working on getting some better code styles as well that should fix the contrast issue.
Re:Daux.io, a simple documentation generator by slajax on Sunday July 14, 2013 @01:34PM (#6041487)
I'd like to see this combined with swagger: https://developers.helloreverb.com/swagger/
Re:Daux.io, a simple documentation generator by justinwars on Monday July 15, 2013 @12:01AM (#6043639)
Interesting idea. I will look into what some possible options are. In the mean time I create a Github issue to track the request: https://github.com/justinwalsh/daux.io/issues/13
Re:Daux.io, a simple documentation generator by fernly on Monday July 15, 2013 @12:22AM (#6043699)
I suppose "daux" is meant to be pronounced "docks" but a French-speaker would say "doh!" like Homer Simpson.

Trivia aside, the front page does nothing to make the purpose or advantages clear. What is "custom documentation"? (Is there another kind?) What is the advantage of "on the fly"? (As opposed to the typical "make doc".)

Is there some way to create a multi-level hierarchy within the "01_Getting_Started.md" filename convention? Is the filename structure the _only_ way to indicate structure? (If so, a trivial structure change turns into a nontrivial exercise of renaming files and getting git or svn to accept renamed files as logically unchanged.) Is there a way to cross-reference (link) between files? Is there a way to output in PDF, or any other format?

Re:Daux.io, a simple documentation generator by bhauer on Sunday July 14, 2013 @12:24PM (#6041286)
This is very nice. Well done! I especially like the clean default styles.

One minor nit: the "fork me on Github" is superimposed over the scrolling pane, so it's not possible to grab the scroll tack. That is, I can only scroll via my mousewheel until the tack is past the fork overlay.

Re:Daux.io, a simple documentation generator by justinwars on Sunday July 14, 2013 @11:56PM (#6043633)
Thanks! We will be pushing a fix for the scrollbar issue.
Re:Daux.io, a simple documentation generator by slajax on Sunday July 14, 2013 @12:05PM (#6041219)
I used something very similar a few years ago. I think it was called dox.js.

Whats the story on the super similar name and ui? Is it the same thing? I'm not trolling, I'm curious if they are related cause it was a great doc system IMO.

Re:Daux.io, a simple documentation generator by justinwars on Monday July 15, 2013 @12:04AM (#6043652)
Wow, we even looked around when naming Daux to make sure there wouldn't be any conflicts. I took a look at the dox project and I think we are going to be ok. It looks to be a significantly different approach.
Re:Daux.io, a simple documentation generator by sergiotapia on Sunday July 14, 2013 @12:06PM (#6041223)
Feedback: If I click the middle mouse button on the documentation here http://daux.io/Getting_Started I get the scroller icon thingy appear. Then I can scroll by moving the mouse right or left and make the content dissapear at which point I go far enough and it bounces back.

This _exact_ same effect happens on Outlook.com if you want to take a look at reproducing it there as well.

Re:Daux.io, a simple documentation generator by pests on Sunday July 14, 2013 @06:58PM (#6042601)
It appears there is more content to the right and you are simply scrolling the page (moving the view opposite to direction of mouse movement) and once you hit the edge it seems to invalidate the drag or something similar.

This is just from playing with it; I haven't had time to check the source yet.

Re:Daux.io, a simple documentation generator by justinwars on Sunday July 14, 2013 @11:57PM (#6043634)
I have heard some people having issues with horizontal scrolling, I am still trying to get to the bottom of this.
Re:Daux.io, a simple documentation generator by nwh on Sunday July 14, 2013 @12:29PM (#6041296)
Please kill the orphans in the "features" section — http://i.imgur.com/mbJ5bX8.png
Re:Daux.io, a simple documentation generator by sohooo on Monday July 15, 2013 @03:46AM (#6044223)
There's also flatdoc http://ricostacruz.com/flatdoc/ which renders the markdown file on the client side ('marked' js parser), so no server-side stuff is needed.
Re:Daux.io, a simple documentation generator by exceptione on Sunday July 14, 2013 @05:08PM (#6042248)
I like the looks. My suggestion would be to distribute it as a single phar-archive (and to allow for hyphens).
Re:Daux.io, a simple documentation generator by robinduckett on Sunday July 14, 2013 @12:16PM (#6041260)
Why does this need PHP?
Re:Daux.io, a simple documentation generator by Wilya on Sunday July 14, 2013 @12:26PM (#6041291)
Because it's written in PHP ?
Re:Daux.io, a simple documentation generator by IanCal on Sunday July 14, 2013 @04:03PM (#6042035)
It's documentation. Why is it not static?
Re:Daux.io, a simple documentation generator by ben336 on Sunday July 14, 2013 @05:05PM (#6042237)
Its generating static files from MD files. That requires a server-side language of some type. The weird part is that it appears to use both Node and PHP.
Re:Daux.io, a simple documentation generator by michaelmior on Sunday July 14, 2013 @04:15PM (#6042069)
Then why does it also need Grunt.js?
Re:Daux.io, a simple documentation generator by akldjlafkjalfk on Sunday July 14, 2013 @07:19PM (#6042669)
with no mousewheel you have problems to scroll. Using the scrollbar is made impossible by overlapping … : (
Re:Daux.io, a simple documentation generator by ronaldsvilcins on Sunday July 14, 2013 @11:28AM (#6041100)
Nice!