Ranter
Join devRant
Do all the things like
++ or -- rants, post your own rants, comment on others' rants and build your customized dev avatar
Sign Up
Pipeless API
![](/static/devrant/img/pipeless-devrant-banner-white.png)
From the creators of devRant, Pipeless lets you power real-time personalized recommendations and activity feeds using a simple API
Learn More
Comments
-
I've used Slate to build documentation, works quite well.
(compiles markdown files to html via ruby inside a docker)
What are you guys using to write long(er|ish) docs? -
I actually like single-page docs, you can reference sections with the URL hash and the browser's full-text search works by default.
I agree that it shouldn't be in the readme and it shouldn't be edited as a single file though.
Related Rants
No, a 33 Page README is not the better choice.
Not for reading.
Not for writing.
Compared to a /Documentation/ folder
+ good overviews / links
rant
formatting
readme
documentation