Amitabh Blog Site - README.md

Introduction

This is a blog site created by Amitabh. It is a simple static blog site where i upload latest tech gossips and news. My blog site created using Next js and markdown files. I have used markdown files to write blogs and Next js to render those markdown files.

Features

• Markdown Support: Write blogs in markdown format.
• SEO Friendly: SEO friendly URLs and meta tags.
• Syntax Highlighting: Code syntax highlighting.
• Responsive: Fully responsive design.
• Light/Dark Mode: Light and dark mode support.
• RSS Feed: RSS feed support.
• Sitemap: Sitemap support.
• Search: Search functionality.
• Tags: Tag support.
• Pagination: Pagination support.

Tech Stack ⚒️

• Next js: Next js for server side rendering.
• Typescript: Typescript for type saftey.
• Zod: Zod for runtime type checking.
• Tailwind CSS: Tailwind CSS for styling.
• Velite: Velite for markdown parsing.
• ESLint: ESLint for linting.
• Prettier: Prettier for formatting.
• Husky: Husky support.
• Lint Staged: Lint staged support.
• Github Actions: Github actions for CI/CD.
• Vercel: Vercel for deployment.
• Google Analytics: Google analytics support.
• TypeScript: TypeScript support for type saftey.
• Zod: Zod for runtime type checking.

Installation

1. Clone the repository.
2. Run npm install to install the dependencies.
3. Run npm run dev to start the development server.
4. Run npm run build to build the project.
5. Run npm run start to start the production server.
6. Run npm run lint to lint the project.
7. Run npm run format to format the project.
8. Run npm run type-check to check the types.
9. Run npm run test to run the tests.
10. Run npm run generate to generate the RSS feed and sitemap.
11. Run npm run deploy to deploy the project.
12. Run npm run analyze to analyze the bundle size.
13. Run npm run clean to clean the project.
14. Run npm run ci to run the CI/CD pipeline.

Folder Structure

.
├── .github
│   └── workflows
│       └── ci.yml
├── .husky
│   └── pre-commit
├── .vscode
│   └── settings.json
├── public
│   ├── favicon.ico
│   ├── images
│   │   └── profile.jpg
│   └── robots.txt
├── src
│   ├── components
│   │   ├── Footer.tsx
│   │   ├── Header.tsx
│   │   ├── Layout.tsx
│   │   ├── Meta.tsx
│   │   ├── Pagination.tsx
│   │   ├── PostCard.tsx
│   │   ├── PostList.tsx
│   │   ├── Search.tsx
│   │   ├── Sidebar.tsx
│   │   └── Tag.tsx
│   ├── hooks
│   │   └── useSearch.ts
│   ├── pages
│   │   ├── _app.tsx
│   │   ├── _document.tsx  
│   │   ├── index.tsx
│   │   ├── post
│   │   │   ├── [slug].tsx
│   │   │   └── index.tsx
│   │   └── tag
│   │       ├── [slug].tsx
│   │       └── index.tsx
│   ├── styles
│   │   ├── global.css
│   │   └── tailwind.css
│   └── types
│       ├── index.ts
│       └── post.ts
├── .env.local
├── .eslintrc.js
├── .gitignore
├── .prettierrc
├── LICENSE
├── next-env.d.ts
├── next.config.js
├── package-lock.json
├── package.json
├── README.md
├── tailwind.config.js
└── tsconfig.json

Contributing

Contributions are always welcome! Please ensure your pull request adheres to the following guidelines:

• Search previous suggestions before making a new one, as yours may be a duplicate.
• Make an individual pull request for each suggestion.
• Use the following format: [RESOURCE](LINK) - DESCRIPTION.
• New categories or improvements to the existing categorization are welcome.
• Keep descriptions short and simple, but descriptive.
• End all descriptions with a full stop/period.
• Check your spelling and grammar.
• Make sure your text editor is set to remove trailing whitespace.
• The pull request and commit should have a useful title.
• Make sure to give proper credits to the original author.
• This repository has a Code of Conduct, please follow it in all your interactions with the project.
• If you have any questions, open an issue.
• Have fun!

Authors

• Amitabh Kumar - Amitabh Kumar

Acknowledgements

• Velite
• Next js
• Tailwind CSS
• Zod
• ESLint
• Prettier
• Husky

License

This project is licensed under the MIT License - see the LICENSE file for details.