Skip to content

Latest commit

 

History

History
63 lines (37 loc) · 1.21 KB

README.rst

File metadata and controls

63 lines (37 loc) · 1.21 KB

Clay

A rapid prototyping tool.

With Clay you can forget about making changes to dozens of HTML files just because you need to add a link in the footer.

You can also use it to prototype your AJAX-driven application or the responses of sending forms, because it acts like a real server.

Quickstart

$ clay new myappname

will generate a new app container with the following structure:

myappname
  ├── source/
  ├─────── static/
  ├── README.md
  └── settings.yml

Inside that folder, run the development server with:

$ clay run

and your site'll be available at http://0.0.0.0:8080/.

Anything you put under source will be render as a page. For instance, source/page.html will be visible at:

http://0.0.0.0:8080/page.html

and source/foo/bar.json at:

http://0.0.0.0:8080/foo/bar.json

To generate a static version of your site, stop the server (with Control + C) and run:

$ clay build

and all the templates will be processed and the result stored inside the build folder.

How to install

Just run:

sudo pip install clay

and you're ready to go.

Happy coding!