angel_markdown 1.0.0+1

  • README.md
  • Installing
  • Versions
  • 0

markdown #

Pub

Markdown view generator for Angel.

With this plug-in, you can easily serve static sites without doing more than writing simple Markdown. Thus, it is a friendly choice for writing API documentation or other tedious HTML-writing tasks.

Installation #

In your pubspec.yaml:

dependencies:
  angel_framework: ^1.0.0
  angel_markdown: ^1.0.0

Usage #

It's very straightforward to configure an Angel server to use Markdown:

configureServer(Angel app) async {
  await app.configure(markdown(
    // The directory where your views are located.
    new Directory('views'),
  ));
}

You can then generate HTML on-the-fly in a request handler. Assuming your view directory contained a file named hello.md, the following would render it as an HTML response:

configureServer(Angel app) async {
  app.get('/hello', (res) => res.render('hello'));
}

package:angel_markdown by default searches for files with a .md extension; however, you can easily override this.

Interpolation #

angel_markdown can interpolate the values of data from locals before building the Markdown.

For example, with the following template species.md:

# Species: {{species.name}}
The species *{{species.genus.name}} {{species.name}}* is fascinating...

You can render as follows:

requestHandler(ResponseContext res) {
  return res.render('species', {
    'species': new Species('sapiens', genius: 'homo')
  });
}

To disable interpolation for a single bracket, prefix it with an @, ex: @{{raw | not_interpolated | angular}}.

Templates #

Markdown is frequently used to build the content of sites, but not the templates. You might want to wrap the content of pages in a custom template to apply pretty CSS and JS, etc:

configureServer(Angel app) async {
  await app.configure(
    markdown(
        // The directory where your views are located.
        new Directory('views'), template: (content, Map locals) {
      return '''<!DOCTYPE html>
<html>
    <head>
        <title>${locals['title']} - My Site</title>
    </head>
    <body>
      $content
    </body>
</html>
        ''';
    }),
  );
}

The template function will have access to whatever values were passed to the renderer, or an empty Map.

Enhancing Markdown #

You can pass an extensionSet to add additional features to the Markdown renderer. By default, this plug-in configures it to enable Github-flavored Markdown.

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:


dependencies:
  angel_markdown: ^1.0.0+1

2. Install it

You can install packages from the command line:

with pub:


$ pub get

Alternatively, your editor might support pub get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


import 'package:angel_markdown/angel_markdown.dart';
  
Version Uploaded Documentation Archive
1.0.0+1 Aug 13, 2017 Go to the documentation of angel_markdown 1.0.0+1 Download angel_markdown 1.0.0+1 archive
1.0.0 Aug 13, 2017 Go to the documentation of angel_markdown 1.0.0 Download angel_markdown 1.0.0 archive
Popularity:
Describes how popular the package is relative to other packages. [more]
0
Health:
Code health derived from static analysis. [more]
--
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
--
Overall:
Weighted score of the above. [more]
0
Learn more about scoring.

The package version is not analyzed, because it does not support Dart 2. Until this is resolved, the package will receive a health and maintenance score of 0.

Analysis issues and suggestions

Support Dart 2 in pubspec.yaml.

The SDK constraint in pubspec.yaml doesn't allow the Dart 2.0.0 release. For information about upgrading it to be Dart 2 compatible, please see https://www.dartlang.org/dart-2#migration.

Maintenance issues and suggestions

Make sure dartdoc successfully runs on your package's source files. (-10 points)

Dependencies were not resolved.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=1.19.0