↓Skip to main content

Quick Start

·1 min
documentation
Table of Contents

Create your own repository 📁 #

Go to the repository, and click the Use this template button, then select Create a new repository. Follow the instructions to create a new repository, feel free to make it either Public or Private.

For more information, please check out Creating a repository from a template.

Edit files 🔧 #

Once your repository is ready, modify the following places to your own <user>/<repo>:

  1. go.mod file, modify the first line.
  2. config/_default/config.toml, change the baseUrl accordingly.

Create an issue ✍️ #

Start by adding a new issue to your repository. Use Markdown to format the content.

For further instruction, see Creating an issue and Basic writing and formatting syntax.

image

Publish your site 🚀 #

Once it’s finished, Close the issue. GitHub Actions should automatically start to build and publish your website.

GitHub Actions

Enable GitHub Pages

  1. Go to Settings
  2. Go to Pages tab, under “Build and deployment”, under “Source”, select Deploy from a branch. Choose gh_pages from the dropdown menu.
    image

After finish the above steps, wait a while, your site should be live at https://<your_name>.github.io/<your_repo> 🎉