Skip to content
This repository was archived by the owner on Mar 16, 2025. It is now read-only.

Conventions

brandondiamond edited this page Feb 6, 2014 · 5 revisions

File Extensions

Direct interpretation

  • .md: Render as Markdown file in default frame.
  • .txt: Render as text file in default frame.
  • .html: Render as HTML file in default frame.
  • README: Human-friendly information detailing conventions, best practices, etc.

Special interpretation

  • .js: Executable client-side javascript
  • .auto.js: Executable client-side javascript to be run when directory loaded by kernel
  • .json: Shared data
  • .link: link to external site, may optionally request authentication
  • .xjs: directory of resources that contains an app's resources and is rendered as a single executable
  • _.*: File is hidden within kernel (begins with an underscore)

Content

  • "#!": specify metadata as a JSON dictionary following the shebang

Data

All JSON data must contain a "v" field that corresponds to a schema version. For as long as data references a particular version, information about the version must be presented as a README.version_number file.

Clone this wiki locally