Skip to content

Commit 31e7261

Browse files
authored
Update README.md
1 parent 2d313d1 commit 31e7261

File tree

1 file changed

+17
-17
lines changed

1 file changed

+17
-17
lines changed

README.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,18 @@
22

33
A clean and modern homepage for a clean and modern organization. This site was built using Gatsby, a static site generator. Currently under development.
44

5-
# To do
5+
## To do
66

77
Aside from minor optimizations, here are the main checklist items before we move to production:
88
- Edit environment variables (GitHub token, Formcarry endpoint and Recaptcha key).
99
- Update projects section, which currently just fetches Anthony's top repositories from GitHub (we could replace it with a slideshow or something).
1010
- Update team member descriptions and photos.
1111

12-
# Contributing
12+
## Contributing
1313

1414
We welcome contributions to this project. First of all, here's the project structure:
1515

16-
## Structure
16+
### Structure
1717

1818
```bash
1919
.
@@ -32,7 +32,7 @@ We welcome contributions to this project. First of all, here's the project struc
3232
└── static # favicon & Netlify redirects
3333
```
3434

35-
## Get started
35+
### Get started
3636

3737
If you're familiar with Gatsby, go ahead and fork the repo and start making changes. Otherwise, here are the steps for local installation:
3838
1. Create an account at [Formik](https://formik.com/?utm_source=smakosh)
@@ -46,15 +46,15 @@ If you're familiar with Gatsby, go ahead and fork the repo and start making chan
4646

4747
[![Powered by Vercel](./powered-by-vercel.svg)](https://vercel.co?utm_source=smakosh)
4848

49-
# How the project was made
49+
## How the project was made
5050

5151
This project was made with a theme called "Gatsby theme portfolio." What follows is the original readme from this theme.
5252

53-
## Theme
53+
### Theme
5454

5555
[Gatsby-theme-portfolio](https://github.com/smakosh/gatsby-theme-portfolio)
5656

57-
## Features
57+
### Features
5858

5959
- Eslint/Prettier configured
6060
- Scores 100% on a11y / Performance / PWA / SEO
@@ -70,15 +70,15 @@ This project was made with a theme called "Gatsby theme portfolio." What follows
7070
- Functional components with ~~Recompose~~ React Hooks! ~~ready to migrate to React hooks!~~
7171
- Fetches your Github pinned projects with most stars (You could customize this if you wish)
7272

73-
## Design
73+
### Design
7474

7575
Project on [Behance](https://www.behance.net/gallery/74172961/Free-Gatsby-portfolio-for-developers)
7676

7777

7878

79-
## Prerequisites
79+
### Prerequisites
8080

81-
### Online
81+
#### Online
8282

8383
1. Create an account at [Formik](https://formik.com/?utm_source=smakosh) and grab your form endpoint url
8484
2. Grab a Google recaptcha key from [Google Recaptcha](https://www.google.com/recaptcha/admin)
@@ -91,15 +91,15 @@ Project on [Behance](https://www.behance.net/gallery/74172961/Free-Gatsby-portfo
9191

9292
To Vercel's now secrets UI form.
9393

94-
### Locally
94+
#### Locally
9595

9696
1. Create an account at [Formik](https://formik.com/?utm_source=smakosh)
9797
2. Install [Yarn](https://yarnpkg.com/en/)
9898
3. Grab a Google recaptcha key from [Google Recaptcha](https://www.google.com/recaptcha/admin)
9999
4. Run `cp .env.development.template .env.development`
100100
5. Run `yarn && yarn start`
101101

102-
### Deploying locally to Vercel
102+
#### Deploying locally to Vercel
103103

104104
I highly recommend that you push to GitHub/GitLab and deploy your repository to Vercel instead or just hit the Deploy button.
105105

@@ -108,15 +108,15 @@ Otherwise, you will have to do the following:
108108
1. Add your secrets one by one using the [Now CLI](https://vercel.co/docs/now-cli)
109109
2. Run `now`
110110

111-
### Clean the cache
111+
#### Clean the cache
112112

113113
This removes the `.cache/` & `public/` folders
114114

115115
```bash
116116
yarn reset
117117
```
118118

119-
## Built with
119+
### Built with
120120

121121
- Adobe XD
122122
- Gatsby
@@ -126,11 +126,11 @@ yarn reset
126126
- VSCode
127127
- And these useful of JavaScript libraries & Gatsby plugins [package.json](package.json)
128128

129-
## License
129+
### License
130130

131131
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details
132132

133-
## Contributors
133+
### Contributors
134134

135135
- [Ajay NS](https://github.com/ajayns) https://github.com/smakosh/gatsby-portfolio-dev/pull/3
136136
- [Ryan Lee](https://github.com/drdgvhbh) https://github.com/smakosh/gatsby-portfolio-dev/pull/6
@@ -141,6 +141,6 @@ This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md
141141
- [Michael Seifarth](https://github.com/Kageetai) https://github.com/smakosh/gatsby-portfolio-dev/pull/27
142142
- [Smakosh](https://smakosh.com)
143143

144-
## Support
144+
### Support
145145

146146
If you love this Gatsby template and want to support me, you can do so through my GitHub profile.

0 commit comments

Comments
 (0)