Neighbor's Preppy Maltese

    ember-prism

    0.13.0 • Public • Published

    Ember-prism

    Ship Shape

    ember-prism is built and maintained by Ship Shape. Contact us for Ember.js consulting, development, and training for your project.

    npm version npm Ember Observer Score Build Status

    This project aims to make re-usable ember components for PrismJS. This project is packaged as an EmberCLI addon.

    Compatibility

    • Ember.js v3.24 or above
    • Ember CLI v3.24 or above
    • Node.js v12 or above

    For Ember <= 3.12 use version 0.7.0 of ember-prism.

    Installation

    Install the ember-cli addon in your ember-cli project:

    ember install ember-prism

    Usage

    Using components

    We have two main components, code-block, and code-inline. They'll take care of running Prism on your code as you transition.

    They accept the code to be rendered by passing a @code argument:

    <CodeBlock @code="<a href='link'>value</a>" @language="markup" />

    While both variants support all features, the former is preferable when the code content is subject to changes (re-rendering). For the latter you may need to use &lt;, and &gt; html attributes to escape <, and > characters so they aren't removed by Handlebars.

    The @language argument is optional, and if passed should match one of Prism's supported languages.

    Overriding Line Numbers

    If you have opted to use the line-numbers plugin within your ember-cli-build.js, then you can optionally pass in @start to <CodeBlock/> to set a custom starting line. This is particularly useful when showing "contiguous" hunks of code (while not showing the entire code file).

    (within ember-cli-build.js):

    module.exports = function (defaults) {
      let app = new EmberAddon(defaults, {
        // other options
        'ember-prism': {
          plugins: ['line-numbers']
        },
      });
    };

    (in your component that renders a <CodeBlock />)

    <CodeBlock @code="<html lang='en'>" @start={{2}} />

    This will result in the code block starting its line numbering from 2, instead of 1.

    Configuration

    You can set which theme, components, and plugins you'd like to use from Prism.

    // ember-cli-build.js
    var app = new EmberApp({
      'ember-prism': {
        'theme': 'twilight',
        'components': ['scss', 'javascript'], //needs to be an array, or undefined.
        'plugins': ['line-highlight']
      }
    })

    If you want to use the default theme, just remove the theme option completely.

    If you want hi-fi Glimmer / Ember highlighting, specify:

    components: ['markup'],

    and somewhere in your app:

    import { setup } from 'ember-prism';
    
    setup();

    Running Locally

    Running tests

    • ember test – Runs the test suite on the current Ember version
    • ember test --server – Runs the test suite in "watch mode"
    • ember try:each – Runs the test suite against multiple Ember versions

    Running the dummy application

    Contributing

    See the Contributing guide for details.

    License

    This project is licensed under the MIT License.

    Install

    npm i ember-prism

    DownloadsWeekly Downloads

    3,402

    Version

    0.13.0

    License

    MIT

    Unpacked Size

    19.9 kB

    Total Files

    15

    Last publish

    Collaborators

    • rwwagner90
    • chuckcarpenter
    • brandonjmckay