Git Product home page Git Product logo

cryptography-research-website's Introduction

Ethereum Foundation Cryptography Website

Web application for the Ethereum Foundation Cryptography team using the Gatsby Theme @lekoarts/gatsby-theme-jodie.

โœจ Features

  • MDX with math support (via KaTeX)
  • Fully customizable through the usage of Gatsby Themes (and Theme UI)
  • Create a project by creating an MDX file and dropping the images into the same folder
  • Extensible custom pages
  • Define colors for each page and the sidebar & content will adapt while maintaining WCAG 2 AA contrast ratios
  • SEO (Sitemap, OpenGraph tags, Twitter tags)
  • WebApp Manifest

๐Ÿš€ Getting Started

1. Install dependencies.

yarn

2. Open the code and start customizing!

Start the site by running yarn start.

Your site is now running at http://localhost:8000!

If you want to learn more about how you can use a Gatsby starter that is configured with a Gatsby theme, you can check out this shorter or longer tutorial. The tutorials don't exactly apply to this starter however the concepts are the same.

๐Ÿ“ Using and modifying the Gatsby starter

This projects use @lekoarts/gatsby-theme-jodie - a Gatsby theme for the primary application scaffolding, configuration and styling.

Important Note: Please read the guide Shadowing in Gatsby Themes to understand how to customize the underlying theme!

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-jodie/ to shadow/override files. The Theme UI config can be configured by shadowing its files in src/gatsby-plugin-theme-ui/.

Changing your fonts

By default, the underlying theme and thus this starter uses "Work Sans" as its font. It's used throughout the site and set as a font-family on the html element.

If you want to change your default font or add any additional fonts, you'll need to change two things:

  1. The configuration for gatsby-omni-font-loader => Responsible for loading the font CSS files
  2. The Theme UI config and its fonts key (see Theme UI Typography Docs) => Responsible for setting the font-family in the example

After adjusting the configuration for gatsby-omni-font-loader you'll need to shadow the theme's Theme UI config and overwrite the fonts key. For the sake of this explanation it's assumed that you replaced "Work Sans" with "Roboto Mono".

Create a file at src/gatsby-plugin-theme-ui/index.js with the following contents:

import { merge } from "theme-ui";
import originalTheme from "@lekoarts/gatsby-theme-jodie/src/gatsby-plugin-theme-ui/index";

const theme = merge(originalTheme, {
  fonts: {
    body: `"Roboto Mono", monospace`,
  },
});

export default theme;

As defined in the Theme Specification body is the default body font family.

Another example: You didn't replace "Work Sans" but added "Roboto Mono" additionally since you want to use it for your headings.

Then you'd not overwrite body but add a heading key:

import { merge } from "theme-ui";
import originalTheme from "@lekoarts/gatsby-theme-jodie/src/gatsby-plugin-theme-ui/index";

const theme = merge(originalTheme, {
  fonts: {
    heading: `"Roboto Mono", monospace`,
  },
});

export default theme;

Change your static folder

The static folder contains the icons, social media images and robots.txt. Don't forget to change these files, too!

๐Ÿค” Questions or problems?

If you have general questions or need help with Gatsby, please go to one of the support platforms mentioned in Gatsby's documentation. If you have a specific question about this project, you can head to the GitHub Discussions of the repository.

๐ŸŽ“ Learning Gatsby

Looking for more guidance? Full documentation for Gatsby lives on Gatsby's website.

Themes

To learn more about Gatsby themes specifically, I recommend checking out the theme docs.

General

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.