Gatsby Markdown Blog Starter
A markdown blog starter with all you need features to start markdown blog. NOTE: this porject is a developed version of Gatsby Advanced Starter.
It aims to provide a minimal base for building advanced GatsbyJS powered Markdown blogs.
It has a basic desgin using typography-theme-stow-lake theme.
How can I use this?
If you are a newcomer to Gatsby who's interested in the implementations of most needed features, this is a great place to start.
If you are interested in a foundation for building ultra-fast websites, you can use this project as a "minimal" starter.
Features
- Gatsby v2 support
- Blazing fast loading times thanks to pre-rendered HTML and automatic chunk loading of JS files
- Separate components for everything
- High configurability:
- Bio section
- User social profiles
- Copyright information
- More!
- Bio section
- Name
- Location
- Description
- Links
- Follow Me button
- Posts in Markdown
- Code syntax highlighting
- Embed YouTube videos
- Embed Tweets
- Typography
- Prism syntax highlighter
- Tags
- Separate page for posts under each tag
- Categories
- Separate page for posts under each category
- Google Analytics support
- NPM scripts for GitHub Pages deployment
- Htaccess ready deployment to apache server
- Social features
- Twitter tweet button
- Facebook share/share count
- Reddit share/share count
- Google+ share button
- LinkedIn share button
- Telegram share button
- SEO
- Sitemap generation
- robots.txt
- General description tags
- Schema.org JSONLD (Google Rich Snippets)
- OpenGraph Tags (Facebook/Google+/Pinterest)
- Twitter Tags (Twitter Cards)
- RSS feeds
- Loading progress for slow networks
- Web App Manifest support (PWA)
- Offline support
/static/and content folders are available to use withgatsby-imageout of the box- Netlify deploy configuration
- CSS Modules / sass support
- Development tools
- ESLint for linting
- Prettier for code style
- Remark-Lint for linting Markdown
- write-good for linting English prose
- gh-pages for deploying to GitHub pages
- CodeClimate configuration file and badge
Getting Started
Install this starter (assuming Gatsby is installed and updated) by running from your CLI:
gatsby new YourProjectName https://github.com/ammarjabakji/gatsby-markdown-blog-starter/
npm run develop # or gatsby developOr you can fork the project, make your changes there and merge new features when needed.
Alternatively:
git clone https://github.com/ammarjabakji/gatsby-markdown-blog-starter/ YourProjectName # Clone the project
cd YourProjectname
rm -rf .git # So you can have your own changes stored in VCS.
npm install # or yarn install
npm run develop # or gatsby developConfiguration
Edit the export object in data/SiteConfig:
module.exports = {
siteTitle: "Gatsby Markdown Blog Starter", // Site title.
siteTitleShort: "GA Markdown Blog Starter", // Short site title for homescreen (PWA). Preferably should be under 12 characters to prevent truncation.
siteTitleAlt: "Gatsby Markdown Blog Starter", // Alternative site title for SEO.
siteLogo: "/logos/logo-1024.png", // Logo used for SEO and manifest.
siteUrl: "https://gatsby-markdown-blog-starter.netlify.com", // Domain of your website without pathPrefix.
pathPrefix: "/gatsby-markdown-blog-starter", // Prefixes all links. For cases when deployed to example.github.io/gatsby-advanced-starter/.
siteDescription: "A GatsbyJS stater with Advanced design in mind.", // Website description used for RSS feeds/meta description tag.
siteRss: "/rss.xml", // Path to the RSS file.
siteFBAppID: "189387411558234", // FB Application ID for using app insights
googleAnalyticsID: "UA-4633244-5", // GA tracking ID.
disqusShortname: "https-vagr9k-github-io-gatsby-advanced-starter", // Disqus shortname.
dateFromFormat: "YYYY-MM-DD", // Date format used in the frontmatter.
dateFormat: "DD/MM/YYYY", // Date format for display.
userName: "Advanced User", // Username to display in the Bio section.
userTwitter: "", // Optionally renders "Follow Me" in the Bio segment.
userGitHub: "", // Add Github link to the footer section.
userLocation: "North Pole, Earth", // User location to display in the Bio section.
userAvatar: "https://api.adorable.io/avatars/150/test.png", // User avatar to display in the Bio section.
userDescription:
"Yeah, I like animals better than people sometimes... Especially dogs. Dogs are the best. Every time you come home, they act like they haven't seen you in a year. And the good thing about dogs... is they got different dogs for different people.", // User description to display in the Bio section.
copyright: "Copyright © 2019. Advanced User", // Copyright string for the footer of the website and RSS feed.
themeColor: "#c62828", // Used for setting manifest and progress theme colors.
backgroundColor: "#e0e0e0" // Used for setting manifest background color.
};You can also optionally set pathPrefix:
module.exports = {
// Note: it must *not* have a trailing slash.
pathPrefix: "/gatsby-markdown-blog-starter" // Prefixes all links. For cases when deployed to example.github.io/gatsby-markdown-blog-starter/.
};WARNING: Make sure to edit static/robots.txt to include your domain for the sitemap!