The zero-UI Web notepad
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
data
lib
public
templates
.gitignore
Cakefile
MIT-LICENSE
README.markdown
config.example.php
config.ru
htaccess.example
index.php

README.markdown

Edith

A quick small wiki, perfect for pasting quick texts or code and sharing it between friends.

Don't worry about saving, it saves at every key stroke. Think of it as a magic zero-UI Web notepad.

Try it out at http://edit.sunfox.org/any-page-name.

Usage

  • /any-page-name: type what you want, it's saved automagically!
  • /any-page-name.txt: raw text version.
  • /any-page-name.html: HTML version through the Markdown syntax.
  • /any-page-name.remark: Slideshow version using Remark.
  • /any-page-name.graphviz: Graph version of the dot syntax using Viz, see WebGraphViz for examples.

Keyboard shortcut cltr-e switches from edit mode to HTML mode.

Favicon

Magic Favicon changing as the page updates

The favicon changes as the page updates and is also an indicator that the page is currently saving or not.

REST

Edith is also a RESTful API. So go ahead and try to PUT or DELETE on these URLs.

Install it yourself

Download the files. For example, using git:

$ git clone https://github.com/sunny/edith.git
$ cd edith

Make the data directory writeable:

$ chmod a+w data

Tell your HTTP server to redirect pages not found to index.php. If you are using Apache:

$ cp htaccess.example .htaccess

Finally, you will need Node to build the JavaScript. Install CoffeeScript and UglifyJS:

$ npm install -g coffee-script uglify-js

You can now compile, compress and generate JavaScript source maps:

$ cake build

Further use

This section is only for ninjas and such.

Configuration

Copy config.example.php to config.php and read the examples to use your own configuration file.

Concurrent Access

Multiple users can see live changes at the same time and not overwrite each other's text. For that you must first install Google Mobwrite on a server and define your endpoint in config.php.

Read-only pages

To make pages read-only, just make them non-writeable on disk:

$ chmod -w data/foo.txt

They will then be shown using the HTML representation through Markdown instead. This is what is used on edit.sunfox.org's homepage.

To deactivate the creation of new pages, simply make the data directory itself non-writeable.

URLs

You may use any file name you like as long as it doesn't end like a representation (.txt or .html).

If you prefer /page.js/txt URLs instead of /page.js.txt, the config file has a setting for you.

Development

You can use PHP's built-in server in development:

$ php -S localhost:3000 index.php

Or if you would prefer to serve the app using Rack, a config.ru is created, using the rack-legacy and rack-rewrite gems.

Contributing

You are welcome to contribute by adding issues and forking the code on Github.

Licence

Edith is released under the MIT License.