4 ms·

I'm one of the maintainers of readthedocs and would love to integrate something like this. We have somewhat integrated support for linking to GitHub as an edito

I'm one of the maintainers of readthedocs and would love to integrate something like this. We have somewhat integrated support for linking to GitHub as an editor, but that is only a half-baked solution.

guynamedloren 12y ago
lifeisstillgood and forsaken - wondering if there's a possibility to connect readthedocs with Penflip? Penflip is a project I'm working on that hosts writing projects backed by git repos, with an in-browser markdown writing interface. It's like a stripped down GitHub for non-techies (and for writing instead of coding). I'm currently not integrating with any external services, but recently have been thinking about it. Maybe something here. Let's chat? Email + twitter in profile.
lifeisstillgood 12y ago
My thoughts (random as they are) - Contenteditable is going to change everything. The range of editors like Aloha knock spots off most CMSes and they are in browser WYSIWYG - People can learn to use markups (cf Wikipedia). But encouraging them to leap from Wysiwig to markup is something best broken in gently. - there must be a subset of a markdown that is simple enough to be reliably translated round trip from ReST to HTML5 - the obvious ones are headers, paragraphs and bullets. Which to be frank probably covers 80% of all formatting the world over. - so an HTML editor that allows both markdown editing directly and a tiny subset of HTML that emits direct as markdown. This is afaik simple to do(?!) - A editor / REST receiver that captures incoming pages and writes back to git repo (I wrote one for Connexions it's on GitHub, the one you reference sounds similar, there are probably dozens) So in my head it seems doable - the use case a? - I think some documentation should often be written before the code - it's part of the requirements capture? - It's frequently useful to have actual users write / improve the user manuals and other docs - and this way they don't have to learn rest immediately.
hsk81 12y ago
Hi forsaken, I've actually thought a while ago about a similar integration, but had simply not the time to go for the idea; I'd be more than open to discuss a possible integration if you think NoTex.ch might be a viable option. Regards, Hasan -- Email: hasan.karahan@blackhan.com

guynamedloren 12y ago

lifeisstillgood and forsaken - wondering if there's a possibility to connect readthedocs with Penflip? Penflip is a project I'm working on that hosts writing projects backed by git repos, with an in-browser markdown writing interface. It's like a stripped down GitHub for non-techies (and for writing instead of coding). I'm currently not integrating with any external services, but recently have been thinking about it. Maybe something here. Let's chat? Email + twitter in profile.

lifeisstillgood 12y ago

My thoughts (random as they are) - Contenteditable is going to change everything. The range of editors like Aloha knock spots off most CMSes and they are in browser WYSIWYG - People can learn to use markups (cf Wikipedia). But encouraging them to leap from Wysiwig to markup is something best broken in gently. - there must be a subset of a markdown that is simple enough to be reliably translated round trip from ReST to HTML5 - the obvious ones are headers, paragraphs and bullets. Which to be frank probably covers 80% of all formatting the world over. - so an HTML editor that allows both markdown editing directly and a tiny subset of HTML that emits direct as markdown. This is afaik simple to do(?!) - A editor / REST receiver that captures incoming pages and writes back to git repo (I wrote one for Connexions it's on GitHub, the one you reference sounds similar, there are probably dozens) So in my head it seems doable - the use case a? - I think some documentation should often be written before the code - it's part of the requirements capture? - It's frequently useful to have actual users write / improve the user manuals and other docs - and this way they don't have to learn rest immediately.

hsk81 12y ago

Hi forsaken, I've actually thought a while ago about a similar integration, but had simply not the time to go for the idea; I'd be more than open to discuss a possible integration if you think NoTex.ch might be a viable option. Regards, Hasan -- Email: hasan.karahan@blackhan.com