https://github.com/sosiristseng/template-hexo-next

Site template powered by Hexo Next and GitHub pages.
https://github.com/sosiristseng/template-hexo-next

github-page hexo hexo-blog static-site template

Last synced: 14 days ago
JSON representation

Site template powered by Hexo Next and GitHub pages.

• Host: GitHub
• URL: https://github.com/sosiristseng/template-hexo-next
• Owner: sosiristseng
• License: mit
• Created: 2020-07-11T02:29:31.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2024-04-01T02:01:52.000Z (10 months ago)
• Last Synced: 2024-04-01T03:23:10.972Z (10 months ago)
• Topics: github-page, hexo, hexo-blog, static-site, template
• Language: Shell
• Homepage: https://sosiristseng.github.io/template-hexo-next/
• Size: 1.13 MB
• Stars: 0
• Watchers: 4
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Site template for Hexo Next

- [Hexo](https://hexo.io/zh-tw/) static site generator.

- Fast and elegant [Next theme](https://theme-next.js.org/).

- GitHub actions building the website to [GitHub pages](https://pages.github.com/)

## Copy over my template site

Hosting GitHub: click `use as template`

In `_config.yml`, Change `baseurl` and your personal settings. See also [Hexo configuration](https://hexo.io/docs/configuration.html).

```yml _config.yml

url: https://username.github.io

root: /repo-name/  # root:/ for personal website (username.github.io)

```

### To enable GitHub pages

Open your repository settings => Pages => GitHub Pages

=> Build and deployment => Source, Select `GitHub actions`

### Customizations

You can customize the theme settings by editing `_config.next.yml`. See also [Next theme settings](https://theme-next.js.org/docs/theme-settings/).

## How to develop (in VSCode)

Clone this repository

```bash

git clone [email protected]:sosiristseng/sosiristseng.github.io.git

cd sosiristseng.github.io

```

Install npm dpendencies with Node package manager (npm).

```bash

npm install

```

Install the [Live Server VSCode extension](https://marketplace.visualstudio.com/items?itemName=ritwickdey.LiveServer).  The settings file `.vscode/settings.json` already points the website root to the `public` folder.

If you are using a subdirectory for your site (e.g., This project resides in https://sosiristseng.github.io/template-hexo-next, so `template-hexo-next` is the subdirectory, corresponding to the `root` entry in `_config.yml`), you may need the mount option for the website to work properly.

The option in `.vscode/settings.json` is:

```json

{

    "liveServer.settings.mount": [

      ["/public", "/template-hexo-next"]

    ],

}

```

Build the website locally and Hexo will watch for file changes

```bash

npm run gwatch

```

Open Live Server by VSCode command palette (Shift + Command + P (Mac) / Ctrl + Shift + P (Windows/Linux)) and see the built website.