From 028cc2379d8def5e5b640cdb4ce6cc1f56007f20 Mon Sep 17 00:00:00 2001 From: Matthias Kretschmann Date: Sun, 14 Mar 2021 01:56:46 +0100 Subject: [PATCH] Update README.md --- README.md | 21 ++++++++++----------- 1 file changed, 10 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index a54e5b6..049806c 100644 --- a/README.md +++ b/README.md @@ -11,12 +11,11 @@ -

- [🎉 Features](#-features) - - [🗂 JSON Resume](#-json-resume) - [💍 One data file to rule all pages](#-one-data-file-to-rule-all-pages) + - [🗂 JSON Resume](#-json-resume) - [🐱 GitHub repositories](#-github-repositories) - [💅 Theme switcher](#-theme-switcher) - [🏆 SEO component](#-seo-component) @@ -41,6 +40,15 @@ The whole [portfolio](https://matthiaskretschmann.com) is a React-based single p Most metadata is powered by one `resume.json` file based on [🗂 JSON Resume](#-json-resume), and one `projects.yml` file to [define the displayed projects](#-one-data-file-to-rule-all-pages). +### 💍 One data file to rule all pages + +All displayed project content is powered by one YAML file where all the portfolio's projects are defined. The project description itself is transformed from Markdown written inside the YAML file into HTML on build time. + +Gatsby automatically creates pages from each item in that file utilizing the [`{ProjectsYaml.slug}.jsx`](src/pages/{ProjectsYaml.slug}.jsx) template. + +- [`content/projects.yml`](content/projects.yml) +- [`src/pages/{ProjectsYaml.slug}.jsx`](src/pages/{ProjectsYaml.slug}.jsx) + ### 🗂 JSON Resume Most site metadata and social profiles are defined in [`content/resume.json`](content/resume.json) based on the [JSON Resume](https://jsonresume.org) standard and used throughout the site as a custom React hook. Additionally, a resume page is created under `/resume`. @@ -51,15 +59,6 @@ If you want to know how, have a look at the respective components: - [`src/pages/resume/index.jsx`](src/pages/resume/index.jsx) - [`src/hooks/use-resume.js`](src/hooks/use-resume.js) -### 💍 One data file to rule all pages - -All displayed project content is powered by one YAML file where all the portfolio's projects are defined. The project description itself is transformed from Markdown written inside the YAML file into HTML on build time. - -Gatsby automatically creates pages from each item in that file utilizing the [`{ProjectsYaml.slug}.jsx`](src/pages/{ProjectsYaml.slug}.jsx) template. - -- [`content/projects.yml`](content/projects.yml) -- [`src/pages/{ProjectsYaml.slug}.jsx`](src/pages/{ProjectsYaml.slug}.jsx) - ### 🐱 GitHub repositories The open source section at the bottom of the front page shows selected GitHub repositories, sourced from GitHub.