Skip to content

Python script to create customizable website intended for GitHub pages

License

Notifications You must be signed in to change notification settings

udithprabhu/personal-page-creator

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Personal Page Creator

Python script to create customizable website intended for GitHub pages.

Inspired by Git Folio

Installing

To install the package, run -

pip install personal-page-creator

Or view it at PyPI

Usage

Initialize

Use init to initialize the config file

ppc init

Init will create a config file which is used to customize the page.

Build

ppc build

Build will use the config file to generate the required HTML and CSS files.

Serve

Want to check the output before hosting? Use 'serve' to start a local http server.

ppc serve

Customizations

Config Keys Input Functions
excluded Specify a list of repo names The specified repos will not be included as part of the site
side_background URL Image from the url will be used as side background of the site
social Dict will key and value Used to give links to the user's profile,Currenty supports linkedin, bitbucket and twitter
cv_path URL or filename Used to give download link to the user's cv ( Curriculum Vitae )

Example

Below is an example config file which uses are the available functions.

{
    "username": "your-github-username",
    "excluded": [ "this-repo-will-be-excluded" ],
    "social" : {
        "linkedin": "linkedin_username",
        "twitter": "twitter_handle",
        "bitbucket": "bitbucket_username"
    },
    "side_background": "http://www.example.com/path/to/image.jpg",
    "cv_path": "path/to/cv.pdf"
}

TODO

  • Config to add organization repo also
  • Add themes

About

Python script to create customizable website intended for GitHub pages

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages