This repository was archived by the owner on Mar 16, 2025. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 4
Conventions
brandondiamond edited this page Feb 6, 2014
·
5 revisions
- .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.
- .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)
- "#!": specify metadata as a JSON dictionary following the shebang
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.