Skip to content
/ about Public template
forked from longpdo/neumorphism

Page github dédiée à mon "about". Basée sur l'excellent theme Jekyll de Neumorphism designed Jekyll theme for personal websites, portfolios and resumes. (https://longpdo.github.io/neumorphism/)

License

Notifications You must be signed in to change notification settings

Virtual-thom/about

 
 

Repository files navigation

Neumorphism

Neumorphism designed Jekyll theme for personal websites, portfolios and resumes.

Open Issues License Jekyll Themes Shield

View Demo · Report Bug · Request Feature

Table of Contents

About The Project

Project Screenshot

This is a personal website built with Jekyll and hosted on Github Pages, which is based on the new Neumorphism design trend and was developed with a mobile-first approach. This can be used by developers, who want to showcase their resume and portfolio. If you want to use this for your own website, fork this repository and then refer to personalize and customize.

Built With

Features

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

brew install node

If you need to switch between Node versions regurlarly, I would recommend to install Node via Node Version Manager.

gem install bundler jekyll

For more information, refer to this.

npm install -g yarn

Installation

1: Clone the repository

git clone https://github.com/longpdo/neumorphism.git

2: Change directory into neumorphism

cd neumorphism

3: Install dependencies

yarn

Usage

  • Run and develop locally with live server at http://localhost:4000, this will also build production-ready JS and SCSS assets with every change
gulp
  • After committing and pushing, see the Settings page of your repository to see where your site is published at via Github Pages.

Personalize and Customize

_config.yml

Edit _config.yml to personalize your site. For documentation, refer to docs/config.md.

Github Metadata Plugin

If you want to automatically have your Github repositories pulled for the Open Source Projects section, then you also need to authenticate yourself for the Github Metadata plugin to work.

You need to generate a new personal access token on GitHub:

  • Go to the Github Token site
  • Select the scope public_repository, and add a description.
  • Confirm and save the settings. Copy the token you see on the page.
  • Create a .env file inside your repository and add your generated JEKYLL_GITHUB_TOKEN:
JEKYLL_GITHUB_TOKEN=0YOUR0GENERATED0TOKEN0

To complete the configuration for the Github Metadata plugin, you also need to change the value of repository inside _config.yml. After this, you should the Github Metadata plugin should work properly.

For optimal results, you should make sure, that every Github project, you want included on this portfolio, has added following informations on Github:

  • Description
  • Homepage link, if there is a live version of it
  • Topics

Example: Github Repository Information Example

_data/*.yml

Edit files inside _data to add information to the portfolio. For documentation, refer to docs/data.md.

Particles.js

Edit assets/particles.json to customize the landing page backgorund animation. For more information, refer to this.

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Acknowledgements

About

Page github dédiée à mon "about". Basée sur l'excellent theme Jekyll de Neumorphism designed Jekyll theme for personal websites, portfolios and resumes. (https://longpdo.github.io/neumorphism/)

Resources

License

Stars

Watchers

Forks

Languages

  • HTML 47.5%
  • SCSS 37.0%
  • JavaScript 15.2%
  • Ruby 0.3%