jaguar_martini 2.1.0-dev1

jaguar_martini #

Jekyll and Hugo like static site generator that uses right mix of Markdown, HTML and Dart

Roadmap #

High priority #

  • [X] Permalink
  • [ ] Sort tags by count
  • [ ] Sort categories by count
  • [ ] Table of content

On the loop #

  • [x] Generate single pages
  • [X] Generate lists
  • [X] Generate sections
  • [X] Generate categories
  • [X] Generate tags
  • [ ] List page pagination
  • [ ] Generate home page
  • [ ] Word counts
  • [ ] Reading time calculation
  • [ ] Post summary

In the future #

  • [ ] Multiple output formats
  • [ ] Translation
  • [ ] Slide show generation
  • [ ] Generate series

Changelog #

0.0.7 #

  • Home page

0.0.6 #

  • Page sorting (Untested)

0.0.5 #

  • Permalinks

0.0.4 #

  • Experimenting with static file serving

0.0.3 #

  • List page generation

0.0.2 #

  • Shortcode parsing

0.0.1 #

  • Markdown processing
  • Basic writer support

Use this package as a library

1. Depend on it

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


dependencies:
  jaguar_martini: ^2.1.0-dev1

2. Install it

You can install packages from the command line:

with pub:


$ pub get

with Flutter:


$ flutter pub get

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

3. Import it

Now in your Dart code, you can use:


import 'package:jaguar_martini/jaguar_martini.dart';
  
Popularity:
Describes how popular the package is relative to other packages. [more]
0
Health:
Code health derived from static analysis. [more]
91
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
75
Overall:
Weighted score of the above. [more]
42
Learn more about scoring.

We analyzed this package on Jul 17, 2019, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.4.0
  • pana: 0.12.19

Platforms

Detected platforms: Flutter, other

Primary library: package:jaguar_martini/jaguar_martini.dart with components: io.

Health suggestions

Fix lib/core/builder.dart. (-3.93 points)

Analysis of lib/core/builder.dart reported 8 hints, including:

line 14 col 62: Use ; instead of {} for empty constructor bodies.

line 56 col 11: Use isNotEmpty instead of length

line 72 col 13: Use isNotEmpty instead of length

line 84 col 13: Use isNotEmpty instead of length

line 99 col 11: Use isNotEmpty instead of length

Fix lib/content_source/fs.dart. (-1.49 points)

Analysis of lib/content_source/fs.dart reported 3 hints:

line 29 col 22: DO use curly braces for all flow control structures.

line 38 col 5: Future results in async function bodies must be awaited or marked unawaited using package:pedantic.

line 39 col 7: Future results in async function bodies must be awaited or marked unawaited using package:pedantic.

Fix lib/models/site_meta.dart. (-1.49 points)

Analysis of lib/models/site_meta.dart reported 3 hints:

line 32 col 19: Use = to separate a named parameter from its default value.

line 35 col 29: Use = to separate a named parameter from its default value.

line 36 col 18: Use = to separate a named parameter from its default value.

Fix additional 6 files with analysis or formatting issues. (-2.49 points)

Additional issues in the following files:

  • lib/server/gencon.dart (3 hints)
  • lib/models/models.dart (1 hint)
  • lib/shortcode/shortcode.dart (1 hint)
  • lib/core/composer/composer.dart (Run dartfmt to format lib/core/composer/composer.dart.)
  • lib/fs_content_source.dart (Run dartfmt to format lib/fs_content_source.dart.)
  • lib/server/fs_writer.dart (Run dartfmt to format lib/server/fs_writer.dart.)

Maintenance issues and suggestions

Support latest dependencies. (-10 points)

The version constraint in pubspec.yaml does not support the latest published versions for 1 dependency (rxdart).

Maintain an example. (-10 points)

Create a short demo in the example/ directory to show how to use this package.

Common filename patterns include main.dart, example.dart, and jaguar_martini.dart. Packages with multiple examples should provide example/README.md.

For more information see the pub package layout conventions.

Package is pre-release. (-5 points)

Pre-release versions should be used with caution; their API can change in breaking ways.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.0.0 <3.0.0
jaguar ^2.4.1 2.4.36
jaguar_cache ^2.1.2 2.1.2
markdown ^2.0.1 2.0.3
path ^1.6.1 1.6.2
rxdart ^0.18.0 0.18.1 0.22.0
stream_transform ^0.0.14 0.0.19
yaml ^2.1.12 2.1.16
Transitive dependencies
args 1.5.2
auth_header 2.1.4
charcode 1.1.2
collection 1.14.11
convert 2.1.1
crypto 2.0.6
http_server 0.9.8+3
jaguar_common 2.1.4
jaguar_serializer 2.2.12
logging 0.11.3+2
meta 1.1.7
mime 0.9.6+3
path_tree 2.2.2
source_span 1.5.5
stack_trace 1.9.3
string_scanner 1.0.4
term_glyph 1.1.0
typed_data 1.1.6
Dev dependencies
stencil ^2.1.0
test ^1.2.0

Admin