https://github.com/cesarferreira/facelift
Quick github-pages generator
https://github.com/cesarferreira/facelift
facelift generator gh-pages node tool
Last synced: 10 months ago
JSON representation
Quick github-pages generator
- Host: GitHub
- URL: https://github.com/cesarferreira/facelift
- Owner: cesarferreira
- License: mit
- Created: 2018-07-16T22:12:23.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2018-07-19T20:44:50.000Z (almost 8 years ago)
- Last Synced: 2025-08-03T12:06:53.675Z (11 months ago)
- Topics: facelift, generator, gh-pages, node, tool
- Language: JavaScript
- Homepage: http://cesarferreira.com/facelift/
- Size: 1.66 MB
- Stars: 24
- Watchers: 3
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# facelift
> Quick github-pages generator
## Install
```sh
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](https://github.com/cesarferreira/drone)
```json
{
"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: https://github.com/cesarferreira/drone",
"npm: https://www.npmjs.com/package/drone"
]
}
]
}
```
> `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](http://cesarferreira.com/drone/)
## Created by
[Cesar Ferreira](https://cesarferreira.com)
## License
MIT © [Cesar Ferreira](http://cesarferreira.com)