diff --git a/README.md b/README.md index 714979b..9d1a1fe 100644 --- a/README.md +++ b/README.md @@ -24,22 +24,30 @@ Before you read on - check out this video: │   │   ├── markdown.md │   │   ├── piratenames.json │   │   └── xtreme.html -│   └── _templates +│ │ +│   ├── _data +│   │   ├── xmen.yaml +│   │   └── families.json +│ │ +│ └── _templates │   ├── default.html │   └── info_page.html └── web ├── about │   ├── index.html │   └── packages -> ../../packages + │ ├── index.html ├── main.dart ├── markdown.html ├── packages -> ../packages ├── piratenames.json + │ ├── styles │   ├── main.css │   ├── main.scss │   └── packages -> ../../packages + │ └── xtreme.html ``` @@ -58,6 +66,26 @@ The following file-formats are supported: - .html - .scss - .css + +**html/_data**: [optional] This is the place where you can store your data-files. +The following file-formats are supported: + +- .yaml +- .json + +**SiteGen** injects your data into a global _data variable. +Here is a sample how to use such data: + +```html + +``` + +**SiteGen** + **html/_templates**: The directory containing your HTML+Mustache templates. diff --git a/example/simple/html/_content/families.html b/example/simple/html/_content/families.html new file mode 100644 index 0000000..2f426e1 --- /dev/null +++ b/example/simple/html/_content/families.html @@ -0,0 +1,13 @@ +title: Families +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + \ No newline at end of file diff --git a/example/simple/html/_content/xmen.html b/example/simple/html/_content/xmen.html new file mode 100644 index 0000000..d88bbbd --- /dev/null +++ b/example/simple/html/_content/xmen.html @@ -0,0 +1,7 @@ +title: X-Men +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + \ No newline at end of file diff --git a/example/simple/html/_data/families.json b/example/simple/html/_data/families.json new file mode 100644 index 0000000..7d17ee5 --- /dev/null +++ b/example/simple/html/_data/families.json @@ -0,0 +1,17 @@ +[ + { + "surname": "Jones", + "members": [ + {"given": "Jim"}, + {"given": "John"}, + {"given": "Jill"} + ] + }, + { + "surname": "Smith", + "members": [ + {"given": "Steve"}, + {"given": "Sally"} + ] + } +] \ No newline at end of file diff --git a/example/simple/html/_data/xmen.yaml b/example/simple/html/_data/xmen.yaml new file mode 100644 index 0000000..048c288 --- /dev/null +++ b/example/simple/html/_data/xmen.yaml @@ -0,0 +1,7 @@ +- Professor X +- Beast +- Colossus +- Cyclops +- Iceman +- Marvel Girl +- Storm diff --git a/example/simple/html/_templates/default.html b/example/simple/html/_templates/default.html index 6dc0258..c60dda1 100644 --- a/example/simple/html/_templates/default.html +++ b/example/simple/html/_templates/default.html @@ -31,7 +31,7 @@

{{title}}

by {{_site.author}} - Template: {{template}} + Template: {{_template}} diff --git a/example/simple/web/about/index.html b/example/simple/web/about/index.html index fcd2555..041d257 100644 --- a/example/simple/web/about/index.html +++ b/example/simple/web/about/index.html @@ -7,7 +7,7 @@ About | HudriWudri - +
@@ -36,8 +36,9 @@

Headline II

Last modified: 30.03.2015 by Mike Mitterer + Template: /Volumes/Daten/DevLocal/DevDart/SiteGen/example/simple/html/_templates/default.html - + \ No newline at end of file diff --git a/example/simple/web/families.html b/example/simple/web/families.html new file mode 100644 index 0000000..6d36591 --- /dev/null +++ b/example/simple/web/families.html @@ -0,0 +1,50 @@ + + + + + Families | HudriWudri + + + + +
+ Home | + Markdown | + XTreme simple | + About +
+ +

Families

+ + + + + + + \ No newline at end of file diff --git a/example/simple/web/index.html b/example/simple/web/index.html index 0188dcd..a70c1c7 100644 --- a/example/simple/web/index.html +++ b/example/simple/web/index.html @@ -43,6 +43,7 @@

Pirate badge1

Last modified: 30.03.2015 by Mike Mitterer + Template: /Volumes/Daten/DevLocal/DevDart/SiteGen/example/simple/html/_templates/default.html diff --git a/example/simple/web/markdown.html b/example/simple/web/markdown.html index 46749f3..418828f 100644 --- a/example/simple/web/markdown.html +++ b/example/simple/web/markdown.html @@ -20,7 +20,7 @@

About SiteGen

About SiteGen (Content)

-

Subheadline (Content)

+

Subheadline

3 ~'s is the minimum for designating and separating a YAML block, but they can be extended longer -- all that matters is that the tildes (~) are on their own line. And anything beyond that gets interpreted as Markdown!

@@ -65,6 +65,7 @@

Subheadline (Content)

Last modified: 3/30/2015 by Mike Mitterer + Template: /Volumes/Daten/DevLocal/DevDart/SiteGen/example/simple/html/_templates/default.html diff --git a/example/simple/web/xmen.html b/example/simple/web/xmen.html new file mode 100644 index 0000000..cea38a7 --- /dev/null +++ b/example/simple/web/xmen.html @@ -0,0 +1,44 @@ + + + + + X-Men | HudriWudri + + + + +
+ Home | + Markdown | + XTreme simple | + About +
+ +

X-Men

+ + + + + + + \ No newline at end of file diff --git a/example/simple/web/xtreme.html b/example/simple/web/xtreme.html index 6fb5abd..b10826b 100644 --- a/example/simple/web/xtreme.html +++ b/example/simple/web/xtreme.html @@ -28,6 +28,7 @@

xtreme

Last modified: 30.03.2015 by Mike Mitterer + Template: /Volumes/Daten/DevLocal/DevDart/SiteGen/example/simple/html/_templates/default.html diff --git a/lib/src/Config.dart b/lib/src/Config.dart index 3166a0c..21af6f4 100644 --- a/lib/src/Config.dart +++ b/lib/src/Config.dart @@ -10,6 +10,7 @@ class Config { static const _CONF_CONTENT_DIR = 'content_dir'; static const _CONF_TEMPLATE_DIR = 'template_dir'; static const _CONF_OUTPUT_DIR = 'output_dir'; + static const _CONF_DATA_DIR = 'data_dir'; static const _CONF_WORKSPACE_DIR = 'workspace'; static const _CONF_DATE_FORMAT = 'date_format'; static const _CONF_YAML_DELIMITER = 'yaml_delimeter'; @@ -27,6 +28,7 @@ class Config { _settings[Config._CONF_CONTENT_DIR] = 'html/_content'; _settings[Config._CONF_TEMPLATE_DIR] = 'html/_templates'; + _settings[Config._CONF_DATA_DIR] = 'html/_data'; _settings[Config._CONF_OUTPUT_DIR] = 'web'; _settings[Config._CONF_WORKSPACE_DIR] = '.'; _settings[Config._CONF_DATE_FORMAT] = 'dd.MM.yyyy'; @@ -57,6 +59,8 @@ class Config { String get outputfolder => _settings[Config._CONF_OUTPUT_DIR]; + String get datafolder => _settings[Config._CONF_DATA_DIR]; + String get workspace => _settings[Config._CONF_WORKSPACE_DIR]; String get dateformat => _settings[Config._CONF_DATE_FORMAT]; @@ -80,6 +84,8 @@ class Config { settings["Content folder"] = contentfolder; settings["Template folder"] = templatefolder; + settings["Data folder"] = datafolder; + settings["Default template"] = defaulttemplate; settings["Output folder"] = outputfolder; settings["Workspace"] = workspace; diff --git a/lib/src/Generator.dart b/lib/src/Generator.dart index aad72a1..3fd1f5e 100644 --- a/lib/src/Generator.dart +++ b/lib/src/Generator.dart @@ -26,6 +26,7 @@ class Generator { final Directory contentDir = new Directory(path.absolute(config.contentfolder)); final Directory templateDir = new Directory(path.absolute(config.templatefolder)); final Directory outputDir = new Directory(path.absolute( config.outputfolder)); + final Directory dataDir = new Directory(path.absolute( config.datafolder)); Validate.isTrue(contentDir.existsSync(),"ContentDir ${contentDir.path} must exist!"); Validate.isTrue(templateDir.existsSync(),"Templatefolder ${templateDir.path} must exist!"); @@ -34,6 +35,9 @@ class Generator { // TODO: support directory hierarchies for markdown, templates and output final List files = _listContentFilesIn(contentDir); final List templates = _listTemplatesIn(templateDir); + final List dataFiles = dataDir.existsSync() ? _listDataFilesIn(dataDir) : new List(); + + final Map dataMap = _getDataMap(dataFiles); _logger.info("Generating .html files..."); for (final File file in files) { @@ -60,9 +64,12 @@ class Generator { pageOptions = _fillInPageNestingLevel(relativeFileName,pageOptions); pageOptions = _fillInDefaultPageOptions(config.dateformat,file, pageOptions,config.siteoptions); + pageOptions['_data'] = dataMap; pageOptions['_content'] = renderTemplate(lines.join('\n'), pageOptions); pageOptions['_template'] = "none"; + _logger.info(pageOptions); + String outputExtension = extension; if (isMarkdown(file) && _isMarkdownSupported(config.usemarkdown, pageOptions)) { pageOptions['_content'] = md.markdownToHtml(pageOptions['_content']); @@ -126,6 +133,16 @@ class Generator { return templateDir.listSync().where((file) => file is File).toList(); } + List _listDataFilesIn(final Directory contentDir) { + return contentDir.listSync(recursive: true) + .where((file) => file is File && ( + + file.path.endsWith('.yaml') || + file.path.endsWith(".json") + + )).toList(); + } + bool _isMarkdownSupported(final bool markdownForSite, final Map page_options) { return markdownForSite || ( page_options.containsKey('markdown_templating') && page_options['markdown_templating'] ); } @@ -199,6 +216,29 @@ class Generator { return pageOptions; } + Map _getDataMap(final List dataFiles) { + final Map dataMap = new Map(); + + dataFiles.forEach((final File file) { + if(file.existsSync()) { + var data; + if(path.extension(file.path) == ".yaml") { + + data = yaml.loadYaml(file.readAsStringSync()); + + } else { + + data = JSON.decode(file.readAsStringSync()); + } + + final String filename = path.basenameWithoutExtension(file.path).toLowerCase(); + dataMap[filename] = data; + } + }); + + return dataMap; + } + /** * Sample: * produces for about/index.html