A starter kit for TypeScript-based Gatsby projects with sensible defaults.
This is a starter kit for Gatsby.js websites written in TypeScript. It includes the bare essentials for you to get started (styling, Markdown parsing, minimal toolset).
- ESLint (with custom ESLint rules)
- Markdown rendering with Remark
- Basic component structure
- Styling with emotion
🚀 Quick start
A nodejs >= 6.0.0 setup with yarn is recommended.
Create a Gatsby site.
gatsby-clipackage globally on your machine.
# using NPM npm install -g gatsby-cli # using YARN yarn global add gatsby-cli
gatsby-clito create a new site and install its dependencies.
gatsby new project-name https://github.com/resir014/gatsby-starter-typescript-plus
Move to project's directory.
Start your site.
# using npm npm start # using yarn yarn start
Open source code using your favorite IDE/Text editor and navigate to
src/directory, this is where your application live.
Build your application for production.
Once you're finished, you can make production build of your app using:
# using npm npm run build # using yarn yarn build
Deploy your app to Github pages!
After building your application in step 3, you're ready to publish your app and go online!
# using npm npm run deploy # using yarn yarn deploy