1.0.9 • Published 5 years ago

personal-page v1.0.9

Weekly downloads
-
License
ISC
Repository
-
Last release
5 years ago

Personal-page

CircleCI Github npm minzip vulnerabilities licence

About

Personal page is a simple command-line tool for generating static personal page that is ready to be served by GitHub pages or any other server. This CLI generates your page from a series of question asked from you. It's customizable and comes with dark and light mode.

Demo

Demo

How to install

npm install -g personal-page

Commands

These are common Page commands used in various situations:

page -v --version - Check package version

page -h --help - Check for command help

page create <folder-name> - Create a new personal page

page edit - Edit an existing personal page

page reset conf - Reset an existing personal page configuration

page deploy - Deploy a new personal page to github pages

page serve - Serve your new personal page locally;

page --help -h - View the above commands and uses;

Getting started

Create

Use the create command to create a new personnal page. You will be prompted for some questions about yourself via the CLI

page create <folder-name>

The page will be genrated and served immediately for preview before deploying to github pages

Edit

Use the edit command to edit existing page

page edit

you will be prompted for a series of question on the changes you would like to make

NOTE: you have to be inside the root folder of your page

Deploy

This command deploys your page to github pages by default

page deploy

you will be prompted to enter your github username and password and a token would be generated for subsequent uses.

NOTE we don't store your credentials

Serve

Use this command to serve and preview your page locally

page serve

Reset conf

Use this command to clear the CLI stored configurations. This might be useful when you encouter github signin errors which most times is as a result of deleted token

page reset conf

Contribution

👍 , would be glad to see you make this tiny tool better

License

MIT