Code Monkey home page Code Monkey logo

Comments (10)

thedrow avatar thedrow commented on July 22, 2024

Website please.

from websocketd.

joewalnes avatar joewalnes commented on July 22, 2024

Sure do! Do you have any sites you've done previously?

from websocketd.

joewalnes avatar joewalnes commented on July 22, 2024

Something clean and simple. A typical bootstrap style site.

A static site that can be hosted on github pages.

from websocketd.

joewalnes avatar joewalnes commented on July 22, 2024

I like the Ansible docs. That looks good.

On Fri, Feb 14, 2014 at 11:03 AM, webscientist [email protected]:

check this one:

https://readthedocs.org/

live example:

http://docs.ansible.com/intro.html

Or check automatic github automatic tools: http://pages.github.com/

they are built with simplicity in mind. Maybe we can evolve from there?

Reply to this email directly or view it on GitHubhttps://github.com//issues/18#issuecomment-35102747
.

from websocketd.

joewalnes avatar joewalnes commented on July 22, 2024

Oh cool. I will check read the docs.

I prefer to host it on github pages (it's free and backed by a powerful
CDN). That's what I do with all my other sites.

On Fri, Feb 14, 2014 at 11:19 AM, webscientist [email protected]:

And that one is the default template :)

You can have read the docs pull docs from github, so you dont have to deal
with the site.

Just create a doc folder, and file organization will represent pages.

You just need an hosting, which, if you want, I can provide to you for
free. Well maybe for a bit of advertising, or in exchange for some of your
consulting time about this software?

Reply to this email directly or view it on GitHubhttps://github.com//issues/18#issuecomment-35104271
.

from websocketd.

joewalnes avatar joewalnes commented on July 22, 2024

Ahh. I assumed rtd was just a template. I'll look into alternatives.

GH pages provides static hosting. You just give it files and it will serve
them. No dynamic server side stuff.

On Fri, Feb 14, 2014 at 11:26 AM, Joe Walnes [email protected] wrote:

Oh cool. I will check read the docs.

I prefer to host it on github pages (it's free and backed by a powerful
CDN). That's what I do with all my other sites.

On Fri, Feb 14, 2014 at 11:19 AM, webscientist [email protected]:

And that one is the default template :)

You can have read the docs pull docs from github, so you dont have to
deal with the site.

Just create a doc folder, and file organization will represent pages.

You just need an hosting, which, if you want, I can provide to you for
free. Well maybe for a bit of advertising, or in exchange for some of your
consulting time about this software?

Reply to this email directly or view it on GitHubhttps://github.com//issues/18#issuecomment-35104271
.

from websocketd.

fjorgemota avatar fjorgemota commented on July 22, 2024

ReadTheDocs is nice, and I dont think that it needs a VPS or a preconfigured shared hosting.

The only requeriment that ReadTheDocs likes is the use of Sphinx, which is a nice documentation generator http://sphinx.readthedocs.org/en/latest/ (The template RTD uses is for Sphinx, anyway)

You can create a Sphinx documentation easily (as its only RST files, which is simple) with the RTD theme from this directory: https://github.com/snide/sphinx_rtd_theme (the instructions are in README) and host in Github Pages, for example. (the only thing that RTD does is pull from your git repository, compile it with the sphinx (and the theme specified) and host in a *.readthedocs.org domain)

I vote for a website, anyway. (documentations generated by Sphinx are nice, always!) (and the default Github's wiki is........unusable generally)

from websocketd.

relekang avatar relekang commented on July 22, 2024

Sphinx docs on readthedocs.org. It is as mentioned above free and easy to set up and possible to use custom domains

From the readthedocs getting started documentation:

Sign up for an account on RTD, then log in. Visit your dashboard and click Import to add your project to the site. Fill in the name and description, then specify where your repository is located. This is normally the URL or path name you’d use to checkout, clone, or branch your code.

from websocketd.

fjorgemota avatar fjorgemota commented on July 22, 2024

Well, this issue is now fixed with the release of http://websocketd.com/ ?

from websocketd.

joewalnes avatar joewalnes commented on July 22, 2024

Yep!

from websocketd.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.