On Thu, Apr 17, 2014 at 1:18 PM, Brian Craft wrote:
> Is there a standard workflow, lein plugin, or such, for building/serving a
> project's README.md, doc/*.md, etc.? During development, I mean, to preview
> the docs while working on them.
>
There is a google chrome browser extension for this t
LightTable has a plugin for live Markdown rendering which I find very useful.
So useful in fact that I created a plugin for live Textile rendering based on
it :)
Sean
On Apr 17, 2014, at 11:18 AM, Brian Craft wrote:
> Is there a standard workflow, lein plugin, or such, for building/serving a
If you just want to preview the docs, Emacs has a markdown-mode -
http://jblevins.org/projects/markdown-mode/. I can type C-c C-c p when
editing my README.md, and a properly formatted version comes up in
Firefox.
On 17 April 2014 19:31, Andrey Antukh wrote:
> Hi.
>
> Personally I don't know any s
Hi.
Personally I don't know any standard way to document clojure libraries, but
if you want generic documentation tool, asciidoc works very well.
Examples:
http://niwibe.github.io/buddy/
http://niwibe.github.io/django-pgjson/
Greetings.
Andrey
2014-04-17 20:18 GMT+02:00 Brian Craft :
> Is t
Is there a standard workflow, lein plugin, or such, for building/serving a
project's README.md, doc/*.md, etc.? During development, I mean, to preview
the docs while working on them.
--
You received this message because you are subscribed to the Google
Groups "Clojure" group.
To post to this gr
On Mon, Jun 25, 2012 at 9:52 PM, John Gabriele wrote:
> I agree that great docs are a top priority, however, the way they're
> currently being provided for external Clojure projects seems to be
> pretty good for the time being. I mean, most Clojure projects are
> using github, and github happily r
On Jun 25, 11:58 pm, Michael Klishin
wrote:
>
> Please don't get discouraged.
Thanks for the kind words, Michael! :) Not discouraged, but rather, I
want to make best use of existing resources.
> There are similar services (readthedocs.org, rubydoc.info) and they took a
> while (years) to
> get
John Gabriele:
> So, it now seems that the alcove --- in its current incarnation --- is
> not as useful as I'd originally thought. I'm going to remove it, and
> instead focus on helping make sure projects on Clojars have their :url
> and :description in order.
John,
Please don't get discouraged.
On Jun 24, 11:32 pm, John Gabriele wrote:
>
> Opinions? Concerns? Wild praise? Searing complaints? General disinterest?
>
Hi all,
Thanks to feeback --- both here and elsewhere. A handful of points are
now clear:
* It probably *is* too much trouble to ask folks to fork & send a
pull-request ju
On Jun 25, 2:36 am, Vinzent wrote:
>
> Honestly, what I'd really appreciate is a full-blown community site, kind
> of mix between clojure-toolbox, clojuredocs and emacswiki.
I like clojure-toolbox. It's categorization of projects is quite
useful, IMO.
--
You received this message because you ar
One thing I forgot to mention: it'd be nice to have Marginalia support,
since it can be used not only for annotated source code, but also for
documentation with embedded tests (although, two-column layout doesn't fit
very well for this purpose, but it's another question).
> That's true. The
me on github (and have
> the source code at hand), so why go to another site?
1. centralized location for docs (easy to find your way to other
project docs)
2. the examples
3. more featureful rendering (I'm using Pandoc for the alcove, and so
it supports extra markdown syntax for things like
On Jun 25, 12:14 am, Michael Klishin
wrote:
> John Gabriele:
>
> > Opinions? Concerns? Wild praise? Searing complaints? General disinterest?
>
> This is a great initiative but so far it seems to focus only on the API
> reference part of documentation.
I'd think that autogenerated docstring docs
It's a great initiative indeed, but I found the project pretty useless in
its current state. Forking the repo and sending a pull request just to add
an example is painful. Also, I can read rendered readme on github (and have
the source code at hand), so why go to another site?
I think what woul
John Gabriele:
> Opinions? Concerns? Wild praise? Searing complaints? General disinterest?
This is a great initiative but so far it seems to focus only on the API
reference part of documentation.
I personally think that documentation guides are just as important [1].
For clojurewerkz.org projec
Hi all,
I was looking for a way to:
* encourage folks to write docs for their Clojure projects
* make usage examples available (like clojuredocs.org has, but for
general Clojure-related projects)
* help semi-standardize how Clojure projects are documented
So I made this:
http://www.unexpe
16 matches
Mail list logo
