Sitetree-gen NPM

sitetree-gen

Sitetree Generator.

Installation

NPM

$ npm install sitetree-gen --save

Usage

CLI

Options:
  --url           target site url. [string]
  --output        output json file path. [string] [default: './sitetree.json']
  --speed         crawl speed. [number] [default: 3000]
  --version, -v   show this version. [boolean]
  --help, -h      show this help. [boolean]

$ sitetree-gen --url http://example.com --output ./sitetree.json --speed 3000

JavaScript

sitetreeGen({
  url: 'http://example.com',
  output: './sitetree.json',
  speed: 5000
}).then((sitetree) => {
  console.log('Complete!!');
});

JSON

{
  "name": "/",
  "title": "Front Page",
  "url": "http://example.com/",
  "children": [
    {
      "name": "archives",
      "children": [
        {
          "name": "category",
          "children": [
            {
              "name": "dog",
              "title": "Dog - Category - Archives - Front Page",
              "url": "http://example.com/archives/category/dog/"
            },
            {
              "name": "cat",
              "title": "Dog - Category - Archives - Front Page",
              "url": "http://example.com/archives/category/cat/"
            }
          ]
        }
      ]
    },
    {
      "name": "about",
      "title": "About - Front Page",
      "url": "http://example.com/about/",
      "children": [
        {
          "name": "animals",
          "title": "Animals - About - Front Page",
          "url": "http://example.com/about/animals/"
        }
      ]
    }
  ]
}