中文版介绍

Hakuba (白馬村 , Hakuba-mura) is a village located in Nagano Prefecture, Japan. If you enjoy hiking or climbing, skiing or other activities, this would be a great place to go (btw I haven't been there yet...)

A fast blog starter that reads data off GitHub Discussions.

See how fast it is in action!!

Please star and fork if you like it!

Hakuba fetches the contents on GitHub Discussions with GitHub GraphQL API and webhooks. Then renders the actual blog pages from them.

Recommended hosting services:

The output directory named build.

• Vercel
• Netlify
• Cloudflare Pages

Deploy with Vercel:

... or continue scrolling for guide about manual deployment

Hakuba just a blog starter，data and code are completely separated，so you can create a empty repository to write posts and pages discussion， and write a script to clone this repository and build.

The advantage of this is that you can easily deploy your blog and don't need to worry about code updates.

There are various ways to configure it, you can choose to configure it all using environment variables, or partly through discussion.

If configured blog through discussion, title must be index, category must be CONFIG_CATEGORY, Here is an example.

Create discussions categories for configurations, posts, and pages. Then Set their format to Announcement.

Hakuba supports mdx and HTML script tags for pages and posts, so don't make them public-editable❗❗❗

Only the page named index will be used as the main configuration. Here is an example.

If you deployed Hakuba using vercel, netlify or Cloudflare Pages, update of the contents could be automated with webhooks when discussions are modified.

• Create a new Deploy Hook.
• Go to the repository settings page to set up the webhook. Select Discussion events.

Clone the repository with git:

git clone [email protected]:YeungKC/Hakuba.git

Then, generate the pages:

# Run any one of them

yarn build
npm run build
pnpm build

Finally, upload the build directory to your web server.

If you are using a fork or clone, you need to run the following command:

git remote add upstream https://github.com/YeungKC/Hakuba.git
git fetch upstream/master
git merge upstream/master
git push origin master

Pages and posts support Markdown front matter for metadata and configuration overrides.

Added page will be displayed in navigation.

If you added page title is __error, it will be replaced the error page.

Here is an example

Here is an example

Because use Mdsvex to preprocess the markdown, the following limitations apply:

In markdown you can begin a code block by indenting 4 spaces. This doesn’t work in mdsvex as indentation is common with XML-based languages. Indenting 4 spaces will do nothing.

see also: https://mdsvex.com/docs#limitations

This project uses action-dependabot-auto-merge for updating dependencies automatically. If there is a CI failure, try to configure Dependabot secrets.

Clone this repository, configure GITHUB_TOKEN and REPOSITORY environment variables, install dependencies with package manager and run:

# Run any one of them

npm run generateData
yarn generateData
pnpm generateData

The post path is src/routes/post/_source/[discussion number].md and the page path is src/routes/_page/[title].md.

• Design a logo.
• Page transitions.
• Pre-download resources.
• Lazy load images.
• Dark mode.

• hexo-theme-cactus, I have used this theme for a long time, it has inspired the current theme of Hakuba.

GPL-3.0