Skip to content

Latest commit

 

History

History
97 lines (61 loc) · 2 KB

README.md

File metadata and controls

97 lines (61 loc) · 2 KB
Raw

VNovel

Pixiv-like theme for novels.

The demo can be seen here: https://vnovel.pages.dev

Features

  • Responsive
  • Support tags
  • Switch Light / Dark
  • Google Analytics
  • Yandex Metrica
  • RSS Feeds
  • Supported i18n (en/ja)
  • Lighthouse 100/100

Installation

Method 1

Inside the folder of your Hugo site run:

$ git clone https://github.com/opera7133/vnovel themes/vnovel

Updating theme:

$ cd themes/vnovel
$ git pull

Method 2

Inside the folder of your Hugo site run:

$ git submodule add https://github.com/opera7133/vnovel.git themes/vnovel

Updating theme:

$ git submodule update --remote --merge

Install dependencies

Copy at least the following files from themes/vnovel/exampleSite to the root folder of your site.

  • package.json
  • tailwind.config.js
  • postcss.config.js

After that, run this command.

$ npm install

For more information read the official setup guide of Hugo.

Getting started

After installing the theme successfully it requires a just a few more steps to get your site running.

Update config file

Copy the config.toml in the exampleSite to the root of your Hugo site. Change strings as you like.

Check your site

In order to see your site in action, run Hugo's built-in local server.

$ npm run start

Now enter localhost:1313 in the address bar of your browser.

Build your site

$ npm run build

Contributing

If you find a bug or have an idea for a feature, feel free to write an issue or make a PR.

License

This theme is released under the MIT license.