All content is formatted in markdown, with some additional Jekyll directives.
Page Contents

LoopBack documentation pages are formatted in GitHub-flavored markdown, with some additional features from Jekyll.

Alerts

For more information, see Alerts.

Styled Box

Puts the content in a highlight box, styled as below. You can add/change style with the style parameter.

This is some content. You can even have a bullet list:

  • One
  • Two
  • Three

Code blocks

JavaScript:

/* This is some random JS
*/
MyModel.observe('before save', function filterProperties(ctx, next) {
  if (ctx.options && ctx.options.skipPropertyFilter) return next();
  if (ctx.instance) {
    FILTERED_PROPERTIES.forEach(function(p) { ctx.instance.unsetAttribute(p); });
  } else {
    FILTERED_PROPERTIES.forEach(function(p) { delete ctx.data[p]; });
  }
  next();
});

Shell script:

# This is some random shell script
npm i -g strongloop
ls -al
mv README.md tmp.txt

For more information, see Code samples.

Tags: