<commit_before><!--
@Author: <NAME> <Karl_Roberts>
@Date:   2016-Aug-02
@Project: suited
@Last modified by:   Karl_Roberts
@Last modified time: 2016-Aug-03
@License: Copyright 2016 <NAME> <<EMAIL>> and <NAME> <<EMAIL>>

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.

-->
status: alpha.

[see the demo](https://suited.github.io/suited.js)
[see the API and howto docs](https://suited.github.io/suited.js/doc_site)

## Suited

The awesome presentation framework allowing you to flick between handy talk slides and detailed document all in a single write once file.

The page can be viewed as a normal marked up document but by clicking ctrl-S it will be toggled be to other presentation modes/representatins such as slide show mode. modes can als be switched by modifying the URL in a RESTful manner.

In presentation mode all 'section' elements marked with the atribute 'data-slide' as a slide that can be navigated through as in a presentation.

The slides will be treated as individual views that fill the screen.

Initial support for HTML in slides, with future language support such as markdown or reStructuredText


#### Decisions so far:

In Deck mode -> all slides included nested are flattened in the nav order eg left and right only with nested showing after their parents.


### Development

#### instalation

    # checkout the project
    git clone <EMAIL>:avocadornd/angular-skeleton.git
    # create a master branch.
    git checkout -b master

    # the next line assumes you have installed
    # Node.js v0.12.2 using nvm
    # as per these instructins :- https://github.com/creationix/nvm/blob/master/README.markdown
    # If you alreeady have Node installed globbaly (you're crazy and headed for pain) then skip the next command
    . ./setupnvm.sh

    # get the build dependencies
    npm install

    # install karma and gulp as globals
      npm install -g gulp
      npm install -g karma-cli



#### run tests
either

    gulp karma

or

    karma start

#### to develp
run the build in a browser with browserify so you can see changes as you code

    gulp


#### Generate documentation

Make sure you have `mkdocs` installed.

```
  pip install mkdocs
```

Then generate the HTML documentation site using gulp

```
  gulp gendocs
```

This will use the files in the `docs` directory as source to generate the documentation
site into the `doc_site` folder

#### package up the production build

    gulp package
<commit_msg>Added travis status icon on Readme<commit_after><!--
@Author: <NAME> <Karl_Roberts>
@Date:   2016-Aug-02
@Project: suited
@Last modified by:   Karl_Roberts
@Last modified time: 2016-Aug-03
@License: Copyright 2016 <NAME> <<EMAIL>> and <NAME> <<EMAIL>>

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.

-->
![travis status](https://travis-ci.org/suited/suited.js.svg?branch=master)
status: alpha.

[see the demo](https://suited.github.io/suited.js)
[see the API and howto docs](https://suited.github.io/suited.js/doc_site)

## Suited

The awesome presentation framework allowing you to flick between handy talk slides and detailed document all in a single write once file.

The page can be viewed as a normal marked up document but by clicking ctrl-S it will be toggled be to other presentation modes/representatins such as slide show mode. modes can als be switched by modifying the URL in a RESTful manner.

In presentation mode all 'section' elements marked with the atribute 'data-slide' as a slide that can be navigated through as in a presentation.

The slides will be treated as individual views that fill the screen.

Initial support for HTML in slides, with future language support such as markdown or reStructuredText


#### Decisions so far:

In Deck mode -> all slides included nested are flattened in the nav order eg left and right only with nested showing after their parents.


### Development

#### instalation

    # checkout the project
    git clone <EMAIL>:avocadornd/angular-skeleton.git
    # create a master branch.
    git checkout -b master

    # the next line assumes you have installed
    # Node.js v0.12.2 using nvm
    # as per these instructins :- https://github.com/creationix/nvm/blob/master/README.markdown
    # If you alreeady have Node installed globbaly (you're crazy and headed for pain) then skip the next command
    . ./setupnvm.sh

    # get the build dependencies
    npm install

    # install karma and gulp as globals
      npm install -g gulp
      npm install -g karma-cli



#### run tests
either

    gulp karma

or

    karma start

#### to develp
run the build in a browser with browserify so you can see changes as you code

    gulp


#### Generate documentation

Make sure you have `mkdocs` installed.

```
  pip install mkdocs
```

Then generate the HTML documentation site using gulp

```
  gulp gendocs
```

This will use the files in the `docs` directory as source to generate the documentation
site into the `doc_site` folder

#### package up the production build

    gulp package

{'fraction_non_alphanumeric': 0.06835611870623541, 'fraction_numerical': 0.008002667555851951, 'mean_word_length': 3.5724085365853657, 'pattern_counts': {'":': 0, '<': 23, '<?xml version=': 0, '>': 25, 'https://': 7, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '3153345', 'n_tokens_mistral': 1705, 'n_tokens_neox': 1610, 'n_words': 809}