lekoartsさんのGatsby Starter Portfolio: Emiliaから原型取ってきました.
- Git Flowを一応回してる(masterとdevelopだけだが.)ので,作業するときはcheckout developとか,masterでgit pullとかをくれぐれも忘れないように.後,CI回しすぎるとThis Check was Cancelledとなって10分くらい待つ羽目になるので注意.
- moduleがないと言われたらnpm rebuildとか.
- サイト更新時はnpm, nodeをこまめにアップデートしておこう(現在node v18).
- git resetを使うと,差分取ってないファイル全部消えるから気をつける.
- content/projects:ここのディレクトリが記事になる.coverはnon-nullableなので何かしら画像用意せなあかん.
- ホットリロードしつつデバッグする時はnpm run develop or gatsby develop.
- gatsby buildしたらいい感じに反映されるっぽい?
- 反映されんかったらブラウザのキャッシュとか消してみる.
- patch-packageを入れた.ので,'npx patch-package @lekoarts/gatsby-theme-emilia-core'とかnode_modules内をいじった時はパッチを作っておくように.
- 一応実行確認したもの.npm v9.2.0, node v18.12.1, nodebrew v1.1.0. condaのnpmは古いから,conda deactivateするのを忘れない.
- 久しぶりにいじる時!!!!!!
- upstream(LekoArtsリポの方)でpackageとか更新されてるはず.
- upstreamからmasterにマージ,その後developにマージ.その後,npm installしてdependenciesを最新のに更新しとく.
- ModuleNotFoundError: Module not found: Error: Can't resolve 'theme-ui' in '/path/path/path'みたいなのが起こったとき
- Package.jsonにとりあえず書き足す("theme-ui": "^0.11.3"的な)
- node_module内の変数を変えるときはhot reloadできないので,いじる→パッチ作成ー>node_module消す→npm install --legacy-depの流れ. gatsby developの時にpatchが当てられてnode_moduleの中が書き換えられる仕組みになっている.
- node versionあげる時は→Node Sass does not yet support your current environmentエラーが出るかもなので,適宜sass-loaderをupdate.npm rebuild node-sassでOK
- nodeのバージョンで怒られたら
nvm use 18
- MDX
- Fully customizable through the usage of Gatsby Themes (and Theme UI)
- Light Mode / Dark Mode
- Page Transitions
- Masonry grid and focus on big images
- SEO (Sitemap, OpenGraph tags, Twitter tags)
- WebApp Manifest
Deploy this starter with one click on Netlify:
Use the Gatsby CLI to clone the site and install dependencies:
npx gatsby new gatsby-starter-portfolio-emilia https://github.com/LekoArts/gatsby-starter-portfolio-emilia
cd gatsby-starter-portfolio-emilia
Start the site by running npm run develop
.
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.
Important Note: Please read the guide Shadowing in Gatsby Themes to understand how to customize the underlying theme!
This starter creates a new Gatsby site that installs and configures the theme @lekoarts/gatsby-theme-emilia
.
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-emilia/
to shadow/override files. The Theme UI config can be configured by shadowing its files in src/gatsby-plugin-theme-ui/
.
New projects will be shown on the index page of this theme and can be added by creating MDX files inside content/projects
. General setup:
- Create a new folder inside
content/projects
- Create a new
index.mdx
file, and add the frontmatter - Add images to the created folder (from step 1)
- Reference your desired images as your
cover
in the frontmatter - Write your content below the frontmatter (optional)
- Use
defer
to opt-in into Deferred Static Generation (DSG) (optional) - Add a
slug
to the frontmatter to use a custom slug, e.g.slug: "/my-slug"
(Optional)
Frontmatter reference:
---
cover: "./sean-foley-0JD7kvxAq0Y-unsplash.jpg"
date: "2019-09-10"
title: "Emilia"
defer: false
slug: "/my-slug"
areas:
- Neon
- Lights
---
The frontmatter alone is enough, if you'd like to add additional content you can do so by writing your content (as usual with MDX) below the frontmatter. It'll be displayed in the header of the project below the date and areas.
Create a file at src/@lekoarts/gatsby-theme-emilia/texts/about-me.mdx
to edit the text.
Place an image with the name avatar
inside the folder content/assets
(or your custom assetsPath
which you defined for the theme).
The static
folder contains the icons, social media images and robots.txt
. Don't forget to change these files, too! You can use Real Favicon Generator to generate the image files inside static
.
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.
Looking for more guidance? Full documentation for Gatsby lives on Gatsby's website.
To learn more about Gatsby themes specifically, I recommend checking out the theme docs.
-
For most developers, I recommend starting with the 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 Gatsby's documentation. In particular, check out the How-to Guides and Reference items in the primary navigation.
Thanks for using this project! I'm always interested in seeing what people do with my projects, so don't hesitate to tag me on Twitter and share the project with me.
Please star this project, share it on Social Media or consider supporting me on GitHub Sponsors!