Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add links in the homepage #11

Merged
merged 12 commits into from
Feb 24, 2022
Merged
Show file tree
Hide file tree
Changes from 11 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .eslintignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
build
node_modules
.docusaurus
*.css
*.svg
41 changes: 41 additions & 0 deletions .eslintrc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
{
"env": {
"browser": true,
"es2021": true,
"jest": true
},
"globals": {
"process": true,
"global": true
},
"extends": ["eslint:recommended", "plugin:react/recommended", "prettier"],
"parserOptions": {
"ecmaFeatures": {
"jsx": true
},
"ecmaVersion": 12,
"sourceType": "module"
},
"plugins": ["react", "react-hooks", "prettier"],
"rules": {
"prettier/prettier": "error",
"react/jsx-sort-props": [
2,
{
"callbacksLast": true,
"shorthandFirst": true,
"reservedFirst": true
}
],
"prefer-destructuring": [
"warn",
{
"object": true,
"array": false
}
],
"no-console": "warn",
"react-hooks/rules-of-hooks": "error",
"react-hooks/exhaustive-deps": "off"
}
}
1 change: 1 addition & 0 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ const config = {
crossorigin: 'anonymous'
}
],

presets: [
[
'classic',
Expand Down
4 changes: 4 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,11 @@
"dependencies": {
"@docusaurus/core": "2.0.0-beta.14",
"@docusaurus/preset-classic": "2.0.0-beta.14",
"@docusaurus/types": "^2.0.0-beta.15",
"@emotion/react": "^11.8.1",
"@emotion/styled": "^11.8.1",
"@mdx-js/react": "^1.6.21",
"@mui/material": "^5.4.2",
"clsx": "^1.1.1",
"hast-util-is-element": "^1.1.0",
"prism-react-renderer": "^1.2.1",
Expand Down
29 changes: 29 additions & 0 deletions src/components/HomepageCard/HomepageCard.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
import React from 'react';
import {CardContent, CardMedia, Typography} from '@mui/material';
import {Blue} from '../../config/colors';

export const HomepageCard = ({title, text, img}) => {
return (
<>
<CardMedia
component="img"
height="60"
title={title}
image={`./img/${img}`}
/>
<CardContent>
<Typography variant="h5" component="div" sx={{color: Blue['darkest']}}>
{title}
</Typography>
<Typography
variant="body2"
sx={{color: Blue['darkest'], textTransform: 'capitalize'}}
>
{text}
</Typography>
</CardContent>
</>
);
};

export default HomepageCard;
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

remove

64 changes: 0 additions & 64 deletions src/components/HomepageFeatures.js

This file was deleted.

62 changes: 62 additions & 0 deletions src/components/HomepageFeatures/HomepageFeatures.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
import React from 'react';
import styles from './HomepageFeatures.module.css';
import {Button, Grid} from '@mui/material';
import HomepageCard from '../HomepageCard/HomepageCard';
import list from '../../config/home.json';
import {useHistory} from '@docusaurus/router';

const overrideLinkStyle = {
flexFlow: 'column nowrap',
width: '100%',
minHeight: '100%',
backgroundColor: '#fff',
[':hover']: {
boxShadow: '-1px 5px 19px 0px rgba(0,0,0,0.3)',
backgroundColor: '#fff'
}
};

export const HomepageFeatures = () => {
const history = useHistory();
dan-ziv marked this conversation as resolved.
Show resolved Hide resolved

const renderCards = () => {
const handleOnClick = linkName => history.push(linkName);
const handleOnKeyDown = (event, linkName) => {
if (event.key === 'Enter') {
history.push(linkName);
}
};
return list.length
? list.map(({linkName, ...props}, idx) => (
<Grid key={idx} item xs={8} md={4}>
<Button
variant="contained"
onClick={() => handleOnClick(linkName)}
onKeyDown={e => handleOnKeyDown(e, linkName)}
sx={overrideLinkStyle}
>
<HomepageCard {...props} />
</Button>
</Grid>
))
: null;
};

return (
<section className={styles.features}>
<div className="container">
<div className="row">
<Grid
container
spacing={4}
sx={{justifyContent: 'center', padding: '0 24px'}}
>
{renderCards()}
</Grid>
</div>
</div>
</section>
);
};

export default HomepageFeatures;
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

remove

9 changes: 9 additions & 0 deletions src/config/colors.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
export const Blue = {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why not in css file?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

'colors' should be reused between many files. Overriding mui-components is much easier using the 'sx' prop, than creating a ccs and importing it, and making sure in it to override relevant classes as seen on the browser (need to manually search the dom).

main: '#3850e9',
dark: 'rgb(25, 45, 160)',
darker: 'rgb(14, 30, 122)',
darkest: 'rgb(3, 13, 79)',
light: 'rgb(126, 141, 238)',
lighter: 'rgb(170, 179, 239)',
lightest: 'rgb(243, 236, 247)'
};
38 changes: 38 additions & 0 deletions src/config/home.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
[
{
"linkName": "docs/CLI/commands",
"img": "undraw_docusaurus_mountain.svg",
"title": "what is starkNet",
"text": "intrudaction to starknet: how it works, main concepts glossary, FAQs"
},
{
"linkName": "docs/CLI/commands",
"img": "undraw_docusaurus_tree.svg",
"title": "building on starknet",
"text": "useful link to help write and deploy your own contracts on starknet"
},
{
"linkName": "docs/CLI/commands",
"img": "undraw_docusaurus_react.svg",
"title": "dev tools",
"text": "tools for development and deployment"
},
{
"linkName": "docs/CLI/commands",
"img": "undraw_docusaurus_mountain.svg",
"title": "discussions",
"text": "starknet community discussions"
},
{
"linkName": "docs/CLI/commands",
"img": "undraw_docusaurus_tree.svg",
"title": "block explorer",
"text": "a link to Voyager, starknet alph block explorer"
},
{
"linkName": "docs/CLI/commands",
"img": "undraw_docusaurus_react.svg",
"title": "latest updates",
"text": "stay up to date with all the latest blog posts, news, and events"
}
]
18 changes: 11 additions & 7 deletions src/css/custom.css
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,20 @@

/* You can override the default Infima variables here. */
:root {
--ifm-color-primary: #25c2a0;
--ifm-color-primary-dark: rgb(33, 175, 144);
--ifm-color-primary-darker: rgb(31, 165, 136);
--ifm-color-primary-darkest: rgb(26, 136, 112);
--ifm-color-primary-light: rgb(70, 203, 174);
--ifm-color-primary-lighter: rgb(102, 212, 189);
--ifm-color-primary-lightest: rgb(146, 224, 208);
--ifm-color-primary: #3850e9;
--ifm-color-primary-dark: rgb(25, 45, 160);
--ifm-color-primary-darker: rgb(14, 30, 122);
--ifm-color-primary-darkest: rgb(3, 13, 79);
--ifm-color-primary-light: rgb(126, 141, 238);
--ifm-color-primary-lighter: rgb(170, 179, 239);
--ifm-color-primary-lightest: rgb(243, 236, 247);
--ifm-code-font-size: 95%;
}

.footer--dark {
--ifm-footer-background-color: rgb(10, 15, 60);
}

.docusaurus-highlight-code-line {
background-color: rgba(0, 0, 0, 0.1);
display: block;
Expand Down
2 changes: 1 addition & 1 deletion src/pages/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import Layout from '@theme/Layout';
import Link from '@docusaurus/Link';
import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
import styles from './index.module.css';
import HomepageFeatures from '../components/HomepageFeatures';
import HomepageFeatures from '../components/HomepageFeatures/HomepageFeatures';

function HomepageHeader() {
const {siteConfig} = useDocusaurusContext();
Expand Down
10 changes: 9 additions & 1 deletion static/img/logo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading