Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
vaetas committed Apr 18, 2021
1 parent fa8bce1 commit 6812e7a
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 8 deletions.
17 changes: 10 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,19 +6,22 @@
> Did he smile his work to see? \
> Did he who made the Lamb make thee?
Blake is an experimental static site generator written in the Dart language.
[Documentation](https://vaetas.github.io/blake/)

Blake is an opinionated static site generator written in Dart lang.
It is provided as a single binary and can be used even without Dart installed.

Features as of now:

* Markdown support.
* YAML configuration and front-matter.
* Jinja templates.
* Live-reload.
* Single native binary.
* Jinja templates. Also usable in Markdown files.
* Live-reload during development.
* Compiled into single native binary.
* YAML/JSON data content and non-public Data pages.
* Define content types for quick creation.
* Basic JSON search index.
* Sitemap generation.
* Pre-defined content types for quick creation.
* Generated JSON search index.
* `sitemap.xml` generation.
* Inline & body shortcodes.

Remember that this project is WIP. Everything can change at any time.
Expand Down
2 changes: 1 addition & 1 deletion lib/blake.dart
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ export 'src/serve/watch.dart';
export 'src/shortcode.dart' show Shortcode, ShortcodeTemplate, ShortcodeParser;
export 'src/sitemap_builder.dart';
export 'src/taxonomy.dart';
export 'src/templates_config.dart';
export 'src/template/templates_config.dart';
export 'src/yaml.dart';

/// [Blake] class ties together all commands and exports callable method for
Expand Down

0 comments on commit 6812e7a

Please sign in to comment.