https://github.com/epoberezkin/gh-pages-generator

Multi-page site generator converting markdown files to github pages
https://github.com/epoberezkin/gh-pages-generator

Last synced: 17 days ago
JSON representation

Multi-page site generator converting markdown files to github pages

• Host: GitHub
• URL: https://github.com/epoberezkin/gh-pages-generator
• Owner: epoberezkin
• Created: 2016-04-16T12:52:01.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2018-04-28T21:56:00.000Z (about 7 years ago)
• Last Synced: 2025-04-13T23:07:40.766Z (23 days ago)
• Language: JavaScript
• Size: 4.88 KB
• Stars: 9
• Watchers: 2
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# gh-pages-generator

Multi-page site generator converting markdown files to github pages

## Istall

```

npm install -g gh-pages-generator

```

## Usage

```

gh-pages-generator site_config.json

```

This utility generates site for gh-pages using multiple markdown files.

It replaces the links between the files and generates site navigation.

Site configuration file is defined by [the JSON-schema](https://github.com/epoberezkin/gh-pages-generator/blob/master/site_config_schema.json).

See [example site configuration in Ajv repository](https://github.com/epoberezkin/ajv/blob/gh-pages/site.json).

If config file is not specified, `site.json` is used.

You can automate site generation with Travis. See [example script](https://github.com/epoberezkin/ajv/blob/master/scripts/travis-gh-pages).