https://github.com/jahed/molecule-js

RSS / Atom Feed Blog Aggregator
https://github.com/jahed/molecule-js

aggregator atom rss

Last synced: 3 months ago
JSON representation

RSS / Atom Feed Blog Aggregator

• Host: GitHub
• URL: https://github.com/jahed/molecule-js
• Owner: jahed
• License: other
• Archived: true
• Created: 2015-04-04T03:34:22.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2019-06-08T22:46:15.000Z (over 5 years ago)
• Last Synced: 2024-09-22T13:32:58.583Z (3 months ago)
• Topics: aggregator, atom, rss
• Language: JavaScript
• Size: 23.4 KB
• Stars: 2
• Watchers: 3
• Forks: 1
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Molecule

[![Build Status](https://img.shields.io/travis/jahed/molecule-js.svg)](https://travis-ci.org/jahed/molecule-js)

[![NPM Release](https://img.shields.io/npm/dt/molecule-js.svg)](https://www.npmjs.com/package/molecule-js)

[![Patreon](https://img.shields.io/badge/patreon-donate-f96854.svg)](https://www.patreon.com/jahed)

RSS / Atom Feed Blog Aggregator

## Dependencies

- NodeJS

- NPM

## Installation

### Global

```sh

npm install -g molecule-js

```

### Local

You can also install Molecule per-project, just run

```sh

npm install molecule-js

```

and use `./node_modules/.bin/molecule` as the command.

### Programmatic

To use Molecule programmatically, see `./src/cli.js` as an example.

```js

var molecule = new Molecule(pathToConfigDir, options);

//...

molecule.build();

```

## Usage

```sh

$ molecule --help

molecule [options] 

Options:

  --pretty, -p

    Disables minification

  --output, -o 

    Default: /build/

```

### Config Directory

See `./config/` as an example.

Path          | Description

------------- | -------------

./config.json | Configuration of your aggregator

./templates/  | Templates you want to generate

#### Templates

Currently only [Pug (previous known as Jade)](http://jade-lang.com/) templates are supported.

Support for other engines might be added if they're needed.

Currently directories in the `templates` directory aren't supported.

To know which variables are available, see the example templates under

`./config/templates`. Actual documentation may be added in the future.

Templates have a naming scheme:

./templates/  | ./build/

------------- | -------------

atom.xml.pug  | atom.xml

README.pug    | README

## License

See `LICENSE`