Package reference
Packages are how Truss organizes functionality.
This page provides a listing of packages in this project, along with a short description of the functionality they provide.
truss-dox • Documentation
Build the documentation in gh-pages.
| Filename | Title | Description |
|---|---|---|
| index.coffee | Documentation | Build the documentation in gh-pages. |
| dynamic/index.coffee | Dynamic documentation | Generate all of the dynamic aspects of the project documentation. |
| dynamic/processor/page/hooks.coffee | Hooks page | Generate the hooks page. |
| dynamic/processor/page/index.coffee | Abstract documentation page | Abstract class to process a documentation page, using a template and generated information. |
| dynamic/processor/page/mkdocs.coffee | mkdocs "page" | Generate the mkdocs.yml. Not technically a page, but fits well enough within the abstraction... |
| dynamic/processor/page/packages.coffee | Packages page | Generate the packages page. |
| dynamic/processor/page/todos.coffee | TODOs page | Generate the TODOs page. |
| dynamic/processor/sources/index.coffee | Abstract sources processor | Abstract class to process the project sources, usually by transforming them to a new form. |
| dynamic/processor/sources/to-markdown.coffee | Markdown source pages | Implementation of SourcesProcessor to convert source to markdown for easy reading. |
Hook invocations
| trussDoxSourceList | invocation |
| trussDoxSourceMarkdownTransform | invocation |
Hook implementations
| trussDoxSourceList | implementation |
| trussDoxSourceMarkdownTransform | implementation |
| trussServerGruntConfig | implementation |
truss-frontend • Front-end system
Front-end abstraction: respond to client, render response, etc.
| Filename | Title | Description |
|---|---|---|
| index.coffee | Front-end system | Front-end abstraction: respond to client, render response, etc. |
| client/require.coffee | Require system for browser. | Implement require in the spirit of NodeJS. |
Hook invocations
| trussFrontendAssetsMiddleware | invocation |
Hook implementations
truss-http • HTTP server
Manage HTTP connections.
| Filename | Title | Description |
|---|---|---|
| abstract.coffee | Abstract HTTP server | An abstract HTTP server interface. |
| index.coffee | HTTP server | Manage HTTP connections. |
| stub/index.coffee | HTTP server stub | A barebones HTTP server. |
| stub/instance.coffee | HTTP server stub - Implementation | Implement TrussHttpServerAbstract. |
| stub/router.coffee | HTTP server stub - Router | Extremely simple and naive routing |
Hook invocations
| trussHttpServerRequestMiddleware | invocation |
| trussHttpServerRoutes | invocation |
Hook implementations
| trussHttpServerRequestMiddleware | implementation |
| trussHttpServerRequestMiddleware | implementation |
| trussServerBootstrapMiddleware | implementation |
| trussServerPackageConfig | implementation |
truss-repl • REPL
Runs a REPL and allows packages to add values to its context.
| Filename | Title | Description |
|---|---|---|
| index.coffee | REPL | Runs a REPL and allows packages to add values to its context. |
Hook invocations
| trussReplServerContext | invocation |