Giter VIP home page Giter VIP logo

my-portfolio's Introduction

Gatsby Starter Portfolio Minimal

A modern one-page portfolio with a clean yet expressive design.

Portfolio Minimal is a Gatsby Starter. Starters are boilerplate projects that can be used to set up new sites effortless. With this starter, you can create a modern one-page portfolio within minutes.

Just install the starter, add your content, and there you go!

Sections · Features · How to Start · Edit Content · Edit Theme · Edit Page Structure · Feedback

>> LIVE DEMO

New Features: 🌛 Dark Mode · 🪟 Splash Screen


Gatsby Starter Portfolio Minimal Screenshot


Sections

The starter has predefined sections as well as a template that you can use to create new, custom sections.

The predefined sections are:

  1. About me
  2. Interests/Skills
  3. Projects
  4. Contact me
  5. Medium articles

Features

🌛 [NEW] Dark Mode - Based on user's preferences.

If the user's OS is set to using dark mode, the Gatsby Starter will automatically switch to a dark theme too.

🕹️ Quick and Easy Setup - Add content and deloy.

Just install the starter, add your content, and deploy it! This starter works seamlessly with hosts like Netlify.

📓 Content Integration via MDX - No external CMS needed.

MDX is a Markdown format that allows you to enrich your content with React components. This makes it fully customizable without external dependencies.

🧰 Extendable Layout - Add more sections as you like.

The starter includes predefined sections as well as a template for new, custom sections. Moreover, you can add new projects to the project section without additional coding.

💅 Responsive Design - With freshening animations.

The starter is designed with a mobile-first approach and looks perfect on small and large breakpoints. Moreover, it has some nice and smooth animations.

Medium Icon Medium Integration - Features latest articles.

In case you are a writer on Medium, the starter has a easy to use Medium integration that allows you to feature your latest articles.

To see all features in action, have a look at the live demo.


How to Start

With Portfolio Minimal, you get up and running in just a few minutes.

  1. Install the Gatsby CLI.

    npm install -g gatsby-cli
    
    
  2. Create a new Gatsby site with the Portfolio Minimal starter.

    gatsby new portfolio-minimal https://github.com/konstantinmuenster/gatsby-starter-portfolio-minimal
    
  3. Start the site in develop mode.

    cd portfolio-minimal
    gatsby develop
    
  4. Open the source code and start editing!


Edit Content

After you installed the starter project, you most likely want to add your own content.

Edit configuration

First, you want to edit the config file which stores the site's configuration (e.g. title, description) and social profiles.

|-- config
    |-- index.js

Navigate to the index.js file in the config folder, edit the configuration, save it, that's it!

Edit page content

Next, you can edit the content for each section you want to be displayed. By default, all sections are shown. If you want to remove certain sections from the site, check out this part of the Readme.

|-- content
    |-- imprint
    |-- index
       |-- about
       |-- contact
       ...
    ...

You find all content in the content folder (surprisingly). For content integration, the project uses MDX, a Markdown format. If you haven't worked with Markdown or MDX before, check the Markdown syntax in Gatsby's docs. They also provide further information about MDX.

To get up and running, just edit the predefined data fields in each mdx file.


Edit Theme

You find the color and font settings in the configuration file, located at: config/index.js.

Note: The usage of the splash screen can be set for each page individually in the page content directory.


Edit Page Structure

To remove or reorder predefined sections, navigate to the src/pages/index.js file. This is the home page of your site.

Each section (besides the Articles section) exists of an imported React component and a GraphQL query that is needed for data querying.

If you want to remove a section, just delete the imported React component and query.

If you want to reorder your sections, just reorder the React components inside the <Layout /> component.

Add custom sections

If you want to add your own custom sections, there is a section template you can use. You can find it in the following directory: src/components/templates


Feedback

Designing and building a portfolio from scratch can be tough. To inspire you and provide you a foundation to build upon, I've decided to publish my personal website as a Gatsby Starter. This boilerplate project should motivate you to build your own awesome portfolio with Gatsby.

I always appreciate feedback, so share your thoughts and suggestions with me: [email protected]

If you find any bugs or have feature suggestions, create a new issue or pull request 🙏

Thanks a lot for using this starter! 💪


License

Distributed under the MIT license.

See LICENSE for more information.

my-portfolio's People

Forkers

raghava0684

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.