Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/molebox/gatsby-theme-dev-resume
A Gatsby theme to create your resume. Enter your details in a json file and the resume will populate the data.
https://github.com/molebox/gatsby-theme-dev-resume
Last synced: 9 days ago
JSON representation
A Gatsby theme to create your resume. Enter your details in a json file and the resume will populate the data.
- Host: GitHub
- URL: https://github.com/molebox/gatsby-theme-dev-resume
- Owner: molebox
- Created: 2020-03-12T17:57:05.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-01-05T09:52:26.000Z (almost 2 years ago)
- Last Synced: 2024-10-14T22:43:38.189Z (23 days ago)
- Language: JavaScript
- Size: 2.21 MB
- Stars: 6
- Watchers: 1
- Forks: 0
- Open Issues: 37
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# gatsby-theme-dev-resume
A Gatsby theme to easily create a resume which can be hosted on the internet and also saved or printed to PDF
Example can be seen here: [gatsby-theme-dev-resume.netlify.com](https://gatsby-theme-dev-resume.netlify.com)
Example:
```js
module.exports = {
plugins: [
{
resolve: 'gatsby-theme-dev-resume',
options: {
showSummary: true,
showReference: true,
website: 'https://richardhaines.dev',
githubUsername: 'molebox',
email: '[email protected]',
twitterUsername: 'studio_hungry',
yourName: 'Richard Haines'
}
}
]
}
```
## Setup
To install run `yarn add gatsby-theme-dev-resume`. A resume folder containing the resume.json file will be created for you will some dummy data. Its important to not change any of the keys in the json file otherwise the site will break.
## Props
The theme supports the following props:
| Name | Optional | Type | Default |
|------------------------------|------------|---------|---------------|
| showSummary | No | boolean | None |
| showReference | No | boolean | None |
| website | No | string | None |
| githubUsername | No | string | None |
| twitterUsername | No | string | None |
| email | No | string | None |
| yourName | No | string | None |
### Props Descriptions
- **showSummary**: Choose if you want to show your summary text at the top of the resume. If false then it wont be shown.
- **showReference**: Choose if you want to show your references text at the bottom of the resume. If false then it wont be shown
- **website**: Your personal website
- **githubUsername**: Your github username
- **twitterUsername**: Your Twitter username without the @
- **email**: Your contact email address
- **yourName**: Its your name silly!
### Customization
The theme is made with theme-ui so customizing it is super easy, in fact its as easy as shadowing the `gatsby-plugin-theme-ui` index file in your `src` file and adding your own colors and fonts.
The current setup looks like this:
```js
export default {
fonts: {
body: "Open Sans",
heading: "Muli"
},
fontWeights: {
body: 300,
heading: 400,
bold: 700
},
lineHeights: {
body: "110%",
heading: 1.125,
tagline: "100px"
},
letterSpacing: {
body: "2px",
text: "5px"
},
colors: {
background: "#FFFFFF",
headerText: "#FFFFFF",
text: "#121212",
header: "#121212",
primary: "#000010",
secondary: "#E7E7E9",
secondaryDarker: "#545455",
accent: "#DE3C4B"
},
breakpoints: ["40em", "56em", "64em"]
};
```
## Built With
- [Gatsby](https://www.gatsbyjs.org/)
- [Theme-UI](https://theme-ui.com/)
## Authors
- **Rich Haines**
## License
This project is licensed under the MIT License