Skip to content

Commit 2aaec97

Browse files
authored
Create notes.md
1 parent 1c19259 commit 2aaec97

File tree

1 file changed

+107
-0
lines changed

1 file changed

+107
-0
lines changed

notes.md

Lines changed: 107 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,107 @@
1+
<p align="center">
2+
<a href="https://cara.lekoarts.de">
3+
<img alt="LekoArts" src="https://img.lekoarts.de/gatsby/gatsby-site-illustration.png" />
4+
</a>
5+
</p>
6+
<h1 align="center">
7+
Gatsby Starter Portfolio: Cara
8+
</h1>
9+
10+
<p align="center">
11+
<a href="https://github.com/LekoArts/gatsby-starter-portfolio-cara/blob/master/LICENSE">
12+
<img src="https://img.shields.io/badge/license-0BSD-blue.svg" alt="Gatsby Starter Portfolio: Cara is released under the 0BSD license." />
13+
</a>
14+
<img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg" alt="PRs welcome!" />
15+
<a href="https://twitter.com/intent/follow?screen_name=lekoarts_de">
16+
<img src="https://img.shields.io/twitter/follow/lekoarts_de.svg?label=Follow%20@lekoarts_de" alt="Follow @lekoarts_de" />
17+
</a>
18+
</p>
19+
20+
Playful and Colorful One-Page portfolio featuring Parallax effects and animations. Using the Gatsby Theme [`@lekoarts/gatsby-theme-cara`](https://github.com/LekoArts/gatsby-themes/tree/master/themes/gatsby-theme-cara).
21+
22+
[**Demo Website**](https://cara.lekoarts.de)
23+
24+
Also be sure to checkout other [Free & Open Source Gatsby Themes](https://themes.lekoarts.de)
25+
26+
## ✨ Features
27+
28+
- Theme UI-based theming
29+
- react-spring parallax effect
30+
- CSS Animations on Shapes
31+
32+
## 🚀 Getting Started
33+
34+
[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/LekoArts/gatsby-starter-portfolio-cara) [![Edit gatsby-starter-portfolio-cara](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/github/LekoArts/gatsby-starter-portfolio-cara/tree/master/)
35+
36+
1. **Create a Gatsby site.**
37+
38+
Use the Gatsby CLI to create a new site, specifying this project
39+
40+
```sh
41+
gatsby new project-name https://github.com/LekoArts/gatsby-starter-portfolio-cara
42+
```
43+
44+
2. **Start developing.**
45+
46+
Navigate into your new site's directory and start it up.
47+
48+
```sh
49+
cd project-name
50+
gatsby develop
51+
```
52+
53+
3. **Open the code and start customizing!**
54+
55+
Your site is now running at `http://localhost:8000`!
56+
57+
If you want to learn more about how you can use a Gatsby starter that is configured with a Gatsby theme, you can checkout this [shorter](https://www.gatsbyjs.org/docs/themes/using-a-gatsby-theme/) or [longer](https://www.gatsbyjs.org/tutorial/using-a-theme/) tutorial. The tutorials don't exactly apply to this starter however the concepts are the same.
58+
59+
## 📝 Using and modifying this starter
60+
61+
**Important Note:** Please read the guide [Shadowing in Gatsby Themes](https://www.gatsbyjs.org/docs/themes/shadowing/) to understand how to customize the underlying theme!
62+
63+
This starter creates a new Gatsby site that installs and configures the theme [`@lekoarts/gatsby-theme-cara`](https://github.com/LekoArts/gatsby-themes/tree/master/themes/gatsby-theme-cara).
64+
65+
Have a look at the theme's README and files to see what options are available and how you can shadow the various components including Theme UI. Generally speaking you will want to place your files into `src/@lekoarts/gatsby-theme-cara/` to shadow/override files. The Theme UI config can be configured by shadowing its files in `src/gatsby-plugin-theme-ui/`.
66+
67+
### Changing content
68+
69+
The content of this project is defined in four `.mdx` files inside the theme's `sections` folder. You can override the files `intro.mdx`, `projects.mdx`, `about.mdx` and `contact.mdx`. This starter has overriden the `intro.mdx` file as an example. Place the other files in the same `src/@lekoarts/gatsby-theme-cara/sections/` folder.
70+
71+
You have to use the `<ProjectCard />` component inside `projects.mdx` to display the cards. Example:
72+
73+
```md
74+
## Projects
75+
76+
<ProjectCard title="Freiheit" link="https://www.behance.net/gallery/58937147/Freiheit" bg="linear-gradient(to right, #D4145A 0%, #FBB03B 100%)">
77+
This project is my entry to Adobe's #ChallengeYourPerspective contest.
78+
</ProjectCard>
79+
```
80+
81+
### Change your `static` folder
82+
83+
The `static` folder contains the icons, social media images and robots.txt. Don't forget to change these files, too!
84+
85+
## 🤔 Questions or problems?
86+
87+
Please open up an issue on the main repository: [LekoArts/gatsby-themes](https://github.com/LekoArts/gatsby-themes). Thanks!
88+
89+
## 🎓 Learning Gatsby
90+
91+
Looking for more guidance? Full documentation for Gatsby lives [on Gatsby's website](https://www.gatsbyjs.org/).
92+
93+
### Themes
94+
95+
- To learn more about Gatsby themes specifically, we recommend checking out the [theme docs](https://www.gatsbyjs.org/docs/themes/).
96+
97+
### General
98+
99+
- **For most developers, I recommend starting with the [in-depth tutorial for creating a site with Gatsby](https://www.gatsbyjs.org/tutorial/).** It starts with zero assumptions about your level of ability and walks through every step of the process.
100+
101+
- **To dive straight into code samples, head [to Gatsby's documentation](https://www.gatsbyjs.org/docs/).** In particular, check out the _Reference Guides_ and _Gatsby API_ sections in the sidebar.
102+
103+
## 🌟 Supporting me
104+
105+
Thanks for using this project! I'm always interested in seeing what people do with my projects, so don't hesitate to tag me on [Twitter](https://twitter.com/lekoarts_de) and share the project with me.
106+
107+
Please star this project, share it on Social Media or consider supporting me on [Patreon](https://www.patreon.com/lekoarts) or [GitHub Sponsor](https://github.com/sponsors/LekoArts)!

0 commit comments

Comments
 (0)