https://github.com/tiennhm/create-simple-blog

A npx script for scaffolding a personal blog
https://github.com/tiennhm/create-simple-blog

algolia-search blog-template docusaurus2 gitcus github-actions github-pages markdown mdx npx personal-website reactjs

Last synced: 2 months ago
JSON representation

A npx script for scaffolding a personal blog

• Host: GitHub
• URL: https://github.com/tiennhm/create-simple-blog
• Owner: TienNHM
• License: mit
• Created: 2023-07-29T16:39:45.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2023-10-07T08:18:57.000Z (over 1 year ago)
• Last Synced: 2024-10-16T08:31:53.439Z (7 months ago)
• Topics: algolia-search, blog-template, docusaurus2, gitcus, github-actions, github-pages, markdown, mdx, npx, personal-website, reactjs
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/create-simple-blog
• Size: 12.7 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# create-simple-blog

A npx script for scaffolding a personal blog

![GitHub Repo stars](https://img.shields.io/github/stars/TienNHM/create-simple-blog)

![GitHub forks](https://img.shields.io/github/forks/TienNHM/create-simple-blog)

![GitHub watchers](https://img.shields.io/github/watchers/TienNHM/create-simple-blog)

![GitHub contributors](https://img.shields.io/github/contributors/TienNHM/create-simple-blog)

![GitHub issues](https://img.shields.io/github/issues/TienNHM/create-simple-blog?color=red)

![GitHub top language](https://img.shields.io/github/languages/top/TienNHM/create-simple-blog?color=cyan)

![GitHub repo size](https://img.shields.io/github/repo-size/TienNHM/create-simple-blog)

![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/TienNHM/create-simple-blog)

![GitHub commit activity](https://img.shields.io/github/commit-activity/m/TienNHM/create-simple-blog?color=g)

![GitHub last commit](https://img.shields.io/github/last-commit/TienNHM/create-simple-blog?color=yellow)

## Features

- [x] Create a blog quickly using `Docusaurus 2`

- [x] Support Blog, Docs, Pages using `Markdown`, `MDX`, `ReactJs`

- [x] Support Search via [Algolia DocSearch](https://docsearch.algolia.com/)

- [x] Auto deploy to GitHub Pages using [GitHub Actions](https://docs.github.com/en/actions/deployment/about-deployments/deploying-with-github-actions)

- [x] Support GitHub Discussions via [GitCus](https://giscus.app/)

- [x] Support Contact Form via [Canny](https://canny.io/)

- [x] Support dark mode

- [x] Support multiple languages

- [x] Support multiple authors, categories, tags

- [x] Support PWA

- [ ] Support RSS

- [ ] Google Analytics, Google Tag Manager

## Installation

```bash

npm install -g create-simple-blog

npx create-simple-blog

```

# Demo

You can see the demo at [https://tiennhm.github.io](https://tiennhm.github.io).

![[Demo](https://tiennhm.github.io)](https://v1.screenshot.11ty.dev/https%3A%2F%2Ftiennhm.github.io/opengraph/_123)

## Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

## License

[MIT](https://choosealicense.com/licenses/mit/)

## Author

[![](https://avatars.githubusercontent.com/u/33385777?v=4&s=100)](https://github.com/TienNHM)