DWNCRWLR

DWNCRWLR is a static site generator.

This repository represents a ready-for-use sample project for usage of the generator itself.

This repository also provides a npm package to integrate the generator to any project structure you want.

Content

• DWNCRWLR
  • Installation
    • Clone
    • Setup
  • Usage
    • Customization
  • Documentation
  • Tests
  • FAQ / Troubleshooting
  • License
  • Further readings
    • Tests

Installation

The repository mainly provides two different approaches for using it:

1. 'Clone and own' the repsoitory and make small and simple configurations to use it or just extend its functionality. If you want to use this approach then follow the instrcutions under the next Section: Clone.

2. Use the npm package within your custom project and provide a configuration. Then follow Section: Setup.

Clone

If you just want to use the project structure provided within this repsoitory you can simply use it by follow the steps below:

1. Clone the repository

   git clone 

2. Edit dwncrwlr.config.json for custom setup

   site: {
   
   },
   build: {
   
   }

   • for any detailed information read Section: Setup

TODO: write about cloning repo, edit config and use structure to generate a site.

Setup

TODO: Write install and edit config.

views

sites

assets

Usage

TODO: Describe assets

Customization

View: partials

View: layouts

Documentation

Tests

Tests can be run by using 'npm test'.

Unit Test are supported by Jasmine.

Spec reporters:

• Junit XML based file output
• Console output

FAQ / Troubleshooting

• How do I do specifically so and so?
  • No problem! Just do this.

License

• MIT license
• Copyright 2018 © comcy.

Further readings

Tests

https://stackoverflow.com/questions/30863565/unit-testing-using-jasmine-and-typescript

https://stackoverflow.com/questions/67299/is-unit-testing-worth-the-effort?rq=1

http://bisaga.com/blog/programming/testing-typescript-node-app-with-jasmine/

https://www.npmjs.com/package/jasmine-trx-reporter