Skip to content
Quick github-pages generator
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs
extras
src
templates/docs
.eslintrc.json
.gitignore
.travis.yml
LICENSE
README.md
cli.js
facelift.json
package-lock.json
package.json
test.js
yarn.lock

README.md

facelift

Quick github-pages generator

Build Status npm npm License

Install

npm install -g facelift

Usage

Usage

   $ facelift

This will use the facelift.json file to generate the docs/ folder with the website content.

Example of a facelift.json for drone

{
    "title": "drone",
    "subtitle": "The missing library manager for Android Developers",
    "installation": "npm i -g drone",
    "url": "https://github.com/cesarferreira/drone",
    "screenshot": "http://cesarferreira.com/drone/res/add4.gif",
    "author": {
        "name": "cesar ferreira",
        "thumbnail": "https://pbs.twimg.com/profile_images/884351017097322496/2mmpORsM_400x400.jpg",
        "homepage": "http://cesarferreira.com"
    },
    "highlights": [
        {
            "title": "Features",
            "items": [
                "Blazing fast way to add libraries",
                "No need to search the web for that library",
                "Add multiple dependencies with a one liner",
                "Automated dependency and package management",
                "Automatic import custom urls (e.g. jitpack)",
                "Intuitive, easy-to-learn tool"
            ]
        },
        {
            "title": "Links",
            "items": [
                "GitHub: <a href='https://github.com/cesarferreira/drone'>https://github.com/cesarferreira/drone</a>",
                "npm: <a href='https://www.npmjs.com/package/drone'>https://www.npmjs.com/package/drone</a>"
            ]
        }
    ]
}

git add and push your code to your remote.

now...

Head to your https://github.com/USERNAME/REPO/settings, scroll down to Github Pages and change the source to master branch /docs folder.

This will generate this website

Created by

Cesar Ferreira

License

MIT © Cesar Ferreira

You can’t perform that action at this time.