Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
knechtionscoding committed Apr 16, 2024
1 parent d61a83e commit 9eb79dc
Showing 1 changed file with 15 additions and 45 deletions.
60 changes: 15 additions & 45 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,58 +1,28 @@
# knechtions.com

Website for Knechtions.com
Website for [knechtions.com](knechtions.com)

<img src="screenshot.png" alt="Gatsby Theme Portfolio Minimal Screenshot" width="700" />
## Development

<a href="https://www.gatsbyjs.com/dashboard/deploynow?url=https://github.com/konstantinmuenster/gatsby-starter-portfolio-minimal-theme" target="_blank">
<img src="https://www.gatsbyjs.com/deploynow.svg" alt="Deploy to Gatsby Cloud" />
</a>
Based on [Portfolio Minimal Theme on Github](https://github.com/konstantinmuenster/gatsby-theme-portfolio-minimal).

# Gatsby Starter Portfolio Minimal Theme
### Pre-Requisites

#### A Gatsby Starter Project to easily get started with the Portfolio Minimal Theme
#### Required

Portfolio Minimal is a Gatsby Theme that let's you create outstanding one-page portfolios within minutes. This Gatsby Starter is a boilerplate project that has the theme pre-installed and pre-configured.
- npm (20+)

Just clone this Gatsby Starter, add the content. And that's it!
#### Recommended

[Live Demo on Gatsby Cloud](https://gatsbystarterportfoliominimalt.gatsbyjs.io/) · [Live Demo on Netlify](https://gatsby-starter-portfolio-minimal-theme.netlify.app/) · [Portfolio Minimal Theme on Github](https://github.com/konstantinmuenster/gatsby-theme-portfolio-minimal)
- nvm

---
### Commands

## Installation
```shell
npm install
gatsby develop
```

1. Install the Gatsby CLI
## Deployment

```sh
npm install -g gatsby-cli
```

2. Create a new Gatsby site with the Portfolio Minimal Starter.

```sh
gatsby new portfolio-minimal https://github.com/konstantinmuenster/gatsby-starter-portfolio-minimal-theme
```

3. Once installed, you can begin developing your site.

```sh
cd portfolio-minimal
gatsby develop
```

4. By default, the Portfolio Minimal Starter has a `content` directory at the root of your Gatsby site. There, you can edit the theme settings as well as add content for your sections. To learn more about it, have a look at the [Readme of Portfolio Minimal](https://github.com/konstantinmuenster/gatsby-theme-portfolio-minimal/tree/main/gatsby-theme-portfolio-minimal#readme).

---

## Issues?

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

Thanks a lot for using this starter! 💪

---

<a href="https://www.buymeacoffee.com/kmuenster" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/default-orange.png" alt="Buy Me A Coffee" height="41" width="174"></a>

Konstantin Münster – [konstantin.digital](https://konstantin.digital)
Deployed via Cloudflare Pages. Merge to main and it'll deploy the site

0 comments on commit 9eb79dc

Please sign in to comment.