Skip to content

Latest commit

 

History

History
204 lines (146 loc) · 5.68 KB

README.md

File metadata and controls

204 lines (146 loc) · 5.68 KB
Raw

Gatsby's multilingual blog starter

Kick off your project with this boilerplate. This starter ships with the several configuration files you might need to get up and running blazing fast app.

🖥️ Minimum starter with some setup

  • Typescript
  • Styled-component
  • i18n
  • PWA (optional)
  • Testing (Jest)

👀 Demo

Demo Site

✅ Status

Build test　 Netlify Status

💯 Lighthouse Performance

performance

🚀 Quick start

  1. Create a Gatsby site.

    Use the Gatsby CLI to create a new site, specifying this repo.

    gatsby new <appname> https://github.com/Zett-8/unbearable-lightness.git

  2. Start developing.

    Navigate into your new site’s directory and start it up.

    cd <appname>/
gatsby develop

  3. Check on browser

    The site is now running at http://localhost:8000

    Note: You'll also see a second link: http://localhost:8000/___graphql. This is a tool you can use to experiment with querying your data. Learn more about using this tool in the Gatsby tutorial.

🇺🇳 Set available languages

  1. Edit i18nLanguages.ts

    Set available languages and default language. They are automatically applied in the project.

    // i18nLanguages.ts

export const i18nLanguages: string[] = [`en`, `ja`]
export const i18nDefaultLanguage: string = `en`

  2. Write Translations for each language

    Translations should be { key:value } format. It can be deeply nested if necessary.

    // locales/index.ts

const translations = {
  index: {
    description: {
      en: `Hello world. This is Multilingual Blog. you can switch languages clicking the top-right button.`,
      ja: `ハローワールド。これは多言語対応ブログです。右上のボタンで言語をスイッチすることが可能です。`,
    },
  },
}

  3. Generate translation.json

    Usually you need to make translation.json file for each language in locales folder. But in this project, all you need to do is just run command yarn i18n

    yarn i18n

🖼️ How to write article

  1. Folder and naming

    The article should be placed in

    /contents/<YEAR>/<MONTH>/<TITLE>/<LANGUAGE>.md

    Gatsby will automatically retrieve all markdown files on build time and make the path for each article as /<LANGUAGE>/_/<TITLE>.

  2. Image ratio and size

    All Images are displayed with 16 / 9 ratio. The size should be bigger than 800 x 450 px.

🏗️ Component architecture

A component file consists of five layers.

  1. Import layer
  2. Type layer
  3. Component layer (Should be stateless. Only concerned rendering.)
  4. Style layer
  5. Container layer (Able to have state and logic.)
/** 1. Import layer **/
import React, { useEffect, useState } from 'react'
import styled from 'styled-components'
import { ChildComponent } from './child-component'

/** 2. Type layer **/
type ContainerProps = {
  className?: string
}

type ComponentProps = {
  className?: string
  someData: any
}

/** 3. Component layer **/
const Component = ({ className, someData }: ComponentProps) => (
  <div className={className}>
    <ChildComponent data={someData} />
  </div>
)

/** 4. Style layer **/
const StyledComponent = styled(Component)`
  width: 100%;
  margin: 16px;

  font-size: 2rem;
`

/** 5. Container layer **/
export const MyComponent = (props: ContainerProps) => {
  const [yourState, setYourState] = useState<string>('')

  useEffect(() => {
    // do something here
  }, [])

  return <StyledComponent {...props} someData={yourState} />
}

📝 What's inside?

A quick look at files and directories you'll see in this project.

.
├── .github
├── __mocks__
├── contents
├── locales
├── src
│    ├── components
│    ├── images
│    ├── pages
│    ├── providers
│    ├── styled
│    └── templates
├── .gitignore
├── .prettierignore
├── .prettierrc
├── gatsby-browser.ts
├── gatsby-config.ts
├── gatsby-node.ts
├── gatsby-ssr.ts
├── gatsby-wrapper.tsx
├── i18nLanguages.ts
├── jest.config.js
├── jest-preprocess.js
├── LICENSE
├── loadershim.js
├── package.json
├── README.md
├── setup-test-env.js
├── tsconfig.json
└── yarn.lock

🎓 Learning Gatsby

Looking for more guidance? Full documentation for Gatsby lives on the website. Here are some places to start:

  • For most developers, we recommend starting with our in-depth tutorial for creating a site with Gatsby. It starts with zero assumptions about your level of ability and walks through every step of the process.

  • To dive straight into code samples, head to our documentation. In particular, check out the Guides, API Reference, and Advanced Tutorials sections in the sidebar.