commit f0d2360d986ce27f4336113ebd52403c1fb45500
parent 3bc5e3de5f06b7ebd3523eb9cbfd62bf441e373d
Author: Agastya Chandrakant <me@hanabi.in>
Date: Thu, 5 Sep 2019 18:19:15 +0530
Add readme
Diffstat:
5 files changed, 29 insertions(+), 89 deletions(-)
diff --git a/README.md b/README.md
@@ -1,97 +1,34 @@
-<!-- AUTO-GENERATED-CONTENT:START (STARTER) -->
-<p align="center">
- <a href="https://www.gatsbyjs.org">
- <img alt="Gatsby" src="https://www.gatsbyjs.org/monogram.svg" width="60" />
- </a>
-</p>
-<h1 align="center">
- Gatsby's default starter
-</h1>
+## Adding new blogs
-Kick off your project with this default boilerplate. This starter ships with the main Gatsby configuration files you might need to get up and running blazing fast with the blazing fast app generator for React.
+1. Create a folder in `src/blogs`, say _`newBlogPost`_.
+2. In the folder _`newBlogPost`_, create a markdown file **`index.md`**.
+3. Put the content of the blog in the **`index.md`** file.
-_Have another more specific idea? You may want to check out our vibrant collection of [official and community-created starters](https://www.gatsbyjs.org/docs/gatsby-starters/)._
+## Frontmatter
-## 🚀 Quick start
+In every blog post, it is necessary to start the blog post with the following content:
-1. **Create a Gatsby site.**
+```markdown
+---
+path: '/uri-to-blog-post'
+date: 'yyyy-mm-dd'
+title: 'Blog Post’s Title'
+tags: ['some', 'tags', 'in', 'lowercase']
+cover: 'www.example.com/path/to/cover/img?compulsory=true'
+excerpt: 'Add excerpt here'
+---
+```
- Use the Gatsby CLI to create a new site, specifying the default starter.
+### Note
- ```sh
- # create a new Gatsby site using the default starter
- gatsby new my-default-starter https://github.com/gatsbyjs/gatsby-starter-default
- ```
+1. All except the excerpt are necessary fields. Make sure you would not be able to escape the single or double quotes in excerpt, so make use of enclosing alternatives.
-1. **Start developing.**
+2. In case if you do not wish to have any tags, keep that parameter to `['']`.
- Navigate into your new site’s directory and start it up.
+3. Use the _`yyyy-mm-dd`_ date format.
- ```sh
- cd my-default-starter/
- gatsby develop
- ```
+4. Make sure path starts with **`/`**, and is unique.
-1. **Open the source code and start editing!**
+## Note about styling
- Your 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](https://www.gatsbyjs.org/tutorial/part-five/#introducing-graphiql)._
-
- Open the `my-default-starter` directory in your code editor of choice and edit `src/pages/index.js`. Save your changes and the browser will update in real time!
-
-## 🧐 What's inside?
-
-A quick look at the top-level files and directories you'll see in a Gatsby project.
-
- .
- ├── node_modules
- ├── src
- ├── .gitignore
- ├── .prettierrc
- ├── gatsby-browser.js
- ├── gatsby-config.js
- ├── gatsby-node.js
- ├── gatsby-ssr.js
- ├── LICENSE
- ├── package-lock.json
- ├── package.json
- └── README.md
-
-1. **`/node_modules`**: This directory contains all of the modules of code that your project depends on (npm packages) are automatically installed.
-
-2. **`/src`**: This directory will contain all of the code related to what you will see on the front-end of your site (what you see in the browser) such as your site header or a page template. `src` is a convention for “source code”.
-
-3. **`.gitignore`**: This file tells git which files it should not track / not maintain a version history for.
-
-4. **`.prettierrc`**: This is a configuration file for [Prettier](https://prettier.io/). Prettier is a tool to help keep the formatting of your code consistent.
-
-5. **`gatsby-browser.js`**: This file is where Gatsby expects to find any usage of the [Gatsby browser APIs](https://www.gatsbyjs.org/docs/browser-apis/) (if any). These allow customization/extension of default Gatsby settings affecting the browser.
-
-6. **`gatsby-config.js`**: This is the main configuration file for a Gatsby site. This is where you can specify information about your site (metadata) like the site title and description, which Gatsby plugins you’d like to include, etc. (Check out the [config docs](https://www.gatsbyjs.org/docs/gatsby-config/) for more detail).
-
-7. **`gatsby-node.js`**: This file is where Gatsby expects to find any usage of the [Gatsby Node APIs](https://www.gatsbyjs.org/docs/node-apis/) (if any). These allow customization/extension of default Gatsby settings affecting pieces of the site build process.
-
-8. **`gatsby-ssr.js`**: This file is where Gatsby expects to find any usage of the [Gatsby server-side rendering APIs](https://www.gatsbyjs.org/docs/ssr-apis/) (if any). These allow customization of default Gatsby settings affecting server-side rendering.
-
-9. **`LICENSE`**: Gatsby is licensed under the MIT license.
-
-10. **`package-lock.json`** (See `package.json` below, first). This is an automatically generated file based on the exact versions of your npm dependencies that were installed for your project. **(You won’t change this file directly).**
-
-11. **`package.json`**: A manifest file for Node.js projects, which includes things like metadata (the project’s name, author, etc). This manifest is how npm knows which packages to install for your project.
-
-12. **`README.md`**: A text file containing useful reference information about your project.
-
-## 🎓 Learning Gatsby
-
-Looking for more guidance? Full documentation for Gatsby lives [on the website](https://www.gatsbyjs.org/). Here are some places to start:
-
-- **For most developers, we recommend starting with our [in-depth tutorial for creating a site with Gatsby](https://www.gatsbyjs.org/tutorial/).** 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](https://www.gatsbyjs.org/docs/).** In particular, check out the _Guides_, _API Reference_, and _Advanced Tutorials_ sections in the sidebar.
-
-## 💫 Deploy
-
-[](https://app.netlify.com/start/deploy?repository=https://github.com/gatsbyjs/gatsby-starter-default)
-
-<!-- AUTO-GENERATED-CONTENT:END -->
+Only the Footer functional component (`src/components/footer.js`) imports `layout.css`.
diff --git a/package.json b/package.json
@@ -23,7 +23,7 @@
"prettier": "^1.18.2"
},
"keywords": [
- "gatsby"
+ ""
],
"license": "MIT",
"scripts": {
diff --git a/src/components/footer.js b/src/components/footer.js
@@ -2,6 +2,8 @@ import { Link } from 'gatsby';
import PropTypes from 'prop-types';
import React from 'react';
+import '../components/layout.css';
+
const Footer = ({ author, name, style }) => (
<footer className={'site-footer outer'} style={{ ...style }}>
<div className={'site-footer-content inner'}>
diff --git a/src/components/layout.js b/src/components/layout.js
@@ -11,7 +11,6 @@ import { useStaticQuery, graphql } from 'gatsby';
import Header from './header';
import Footer from './footer';
-import './layout.css';
const Layout = ({ children }) => {
const { site } = useStaticQuery(graphql`
diff --git a/src/pages/index.js b/src/pages/index.js
@@ -64,7 +64,9 @@ export default function IndexPage(props) {
>
<header className="postCardHeader">
<span className={'post-card-tags'}>
- {frontmatter.tags ? frontmatter.tags[0] + ` • ` : ``}{' '}
+ {frontmatter.tags && frontmatter.tags[0].length
+ ? frontmatter.tags[0] + ` • `
+ : ``}{' '}
{publishDate}
</span>
<h2 className={'post-card-title'}>{frontmatter.title}</h2>
