meteor-inline-help
This is a simple inline help package for Meteor.
How to Use
install it from atmosphere
for Meteor 0.9+
meteor add pahans:inline-helpfor Meteor 0.8
mrt add inline-helpfor versions before Meteor 0.8
mrt add inline-help --pkg-version 0.1.5Fetch your help information
property message, supports markdown
var helpData = {
'help-name': {
title: "Help document title ",
message: "Help document message", //supports Markdown
url: "http://YOUR_URL_TO_ADDITIONAL_HELP",
options: {
placement: 'right'
}
},
'another-help-name': {
title: "another help document title ", //supports Markdown
message: "another help document message",
url: "http://YOUR_URL_TO_ADDITIONAL_HELP"
},
}
InlineHelp.initHelp(helpData); - 'title', 'url' and 'options' are optional parameters
- you can use bootstrap popover options.
Markup
use showHelp handlebars helper
for versions before Meteor 0.8
{{showHelp 'help-name'}}for Meteor 0.8+
{{>showHelp 'help-name'}}Styling
- .show-help-icon - if you need to set a custom icon
- .inline-help-popover - wrapped element in bootstrap popover
