-
Fork this project
-
Clone to your local
You may use
GitHub Desktop
Application -
Open the code and start customizing!
You may use
Visual Studio Code
-
Instal dependencies first
yarn install
-
Run blog
gatsby develop
Your site is now running at
http://localhost:8000
!CTRL + Click
to see it on a browser. -
Add a new Event Create a file with
seo-friendly name
and.mdx
extension to this pathcontent > posts
. -
If you cannot see the latest added mdx on localhost
Run these commands
```shell
gatsby clean
```
then
```shell
gatsby build
```
then
```shell
gatsby develop
```
- How to publish? Commit and push the changes to your repository. Then Create a Pull Request to Original Repository. When the Contributers Accepts your PR then it will publish on the website.
Here are the top-level files and directories you'll see in a site created using the blog theme starter:
gatsby-starter-blog-theme
├── content
│ ├── assets
│ │ └── avatar.png
│ └── posts
│ ├── hello-world.mdx
│ └── other-event-names.mdx
├── src
│ └── gatsby-theme-blog
│ ├── components
│ │ └── bio-content.js
│ └── gatsby-theme-ui
│ └── colors.js
├── .gitignore
├── .prettierrc
├── gatsby-config.js
├── LICENSE
├── package-lock.json
├── package.json
└── README.md
-
/content
: A content folder holding assets that the theme expects to exist. This will vary from theme to theme -- this starter is set up to get you started with the blog theme, which expects an image asset for your avatar, and blog post content. Replace the avatar image file, delete the demo posts, and add your own! -
/src
: You will probably want to customize your site to personalize it. The files under/src/gatsby-theme-blog
shadow, or override, the files of the same name in thegatsby-theme-blog
package. To learn more about this, check out the guide to getting started with using the blog theme starter. -
.gitignore
: This file tells git which files it should not track / not maintain a version history for. -
.prettierrc
: This file tells Prettier which configuration it should use to lint files. -
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. When using themes, it's where you'll include the theme plugin, and any customization options the theme provides. -
LICENSE
: Gatsby is licensed under the MIT license. -
package-lock.json
(Seepackage.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). -
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. -
README.md
: A text file containing useful reference information about your project.