Blog With GitHub Boilerplate

screenshot of Blog With GitHub Boilerplate

Blog With GitHub Boilerplate

这是博客文章《完全用 GitHub 写博客》所提出流程的示例仓库。

Overview:

Blog-With-GitHub-Boilerplate is a method for writing a blog using GitHub and Maverick that provides a step-by-step process for setting up and customizing a blog on GitHub Pages. This method utilizes GitHub Actions for automatic updates and allows users to easily add and modify blog articles using a Markdown editor.

Features:

  • GitHub Pages Integration: Easily publish your blog to GitHub Pages by enabling the Pages service in the repository settings.
  • Automated Updates: Use GitHub Actions and a personal token to automatically update your website whenever new changes are pushed to the repository.
  • Customization Options: Modify the site name, author information, description, and other settings to personalize your blog.
  • Image Hosting: Use jsDelivr as a CDN service to host and serve images on your blog.
  • Flexible Editing: Edit and modify your blog articles either through Git on your local machine or directly in the browser.

Installation:

  1. Fork the Blog-With-GitHub-Boilerplate repository to your GitHub account.
  2. Enable GitHub Pages by going to the forked repository's Settings and selecting the gh-pages branch as the publishing source.
  3. Generate a personal token by visiting the provided URL, naming the token, and selecting the "repo" checkbox. Copy the generated token.
  4. In the repository settings, navigate to the Secrets tab and create a new secret named "PERSONAL_TOKEN" with the copied token as the value.
  5. Make modifications to the website's settings by opening the conf.py file. Customize options such as site name, author, and description.
  6. Publish new content by creating a new file in the src folder. Provide a file name and content in Markdown format.
  7. Optionally, use jsDelivr as the CDN service for hosting images. Modify the conf.py file to enable jsDelivr.
  8. Customize and further modify the blog by editing the conf.py file. Additional options and settings can be found in the Maverick/README.md file.
  9. For local development, clone the repository to your local machine and make modifications using Git.
  10. To bind a custom domain, update the CNAME file in the src/static folder with your domain and modify the site_prefix in conf.py to "/".

Summary:

Blog-With-GitHub-Boilerplate provides a straightforward approach to create and maintain a blog using GitHub and Maverick. With its integration with GitHub Pages and automated updates using GitHub Actions, users can easily set up and customize their blog while enjoying the flexibility of editing content either locally or directly in the browser. Additionally, features like image hosting through jsDelivr and the ability to bind a custom domain make Blog-With-GitHub-Boilerplate a versatile solution for creating and managing a blog on GitHub.

blog
Blog

Blog websites feature posts written by one or more authors, organized by categories and tags, with a section for comments and archives sorted by date or topic. Additional features may include search bar, social media sharing, subscription or RSS feed, about and contact pages, and visual content.

github-pages
GitHub Pages

Gridsome is a Vue.js-based static site generator that makes it easy to build fast and flexible websites and applications by leveraging modern web technologies like GraphQL, Webpack, and hot reloading