Skip to content

Latest commit

 

History

History
64 lines (55 loc) · 1.34 KB

README.md

File metadata and controls

64 lines (55 loc) · 1.34 KB
Raw

include-me

Build Status

include-me is basic templating project which import file content to selected file inside folder and its sub folders.

INSTALLATION

$ yarn add include-me
$ npm install include-me

USAGE

Example Folder Structure

.
+-- pages
|   +-- common
|       +-- footer.html
|   +-- index.html

Content of 'footer.html'

<footer>
    Hello From Footer
</footer>

Content of 'index.html'

<template>
    <html>
        <head></head>
        <body>
            Hello From Content
            ${include('footer')}
        </body>
    </html>
</template>

Run

const includeMe = new IncludeMe(__dirname + '/pages', 'name');

const asObject = includeMe.load().asObject();
const asArray = includeMe.load().asArray();

See example folder.

Issues

  • auto publish npm package
  • create continuous integration
  • add recursive import functionality
  • solve the cycle problem
  • add error handle functionality (almost done)
  • write the all unit tests (almost done)
  • write documentation (Basic)
  • add badges(travis, license, npm in future)
  • add license file

Authors

  • Emre Kul