https://github.com/opera7133/vnovel
Pixiv-like theme for novels
https://github.com/opera7133/vnovel
hugo-site hugo-theme tailwind-css
Last synced: about 2 months ago
JSON representation
Pixiv-like theme for novels
- Host: GitHub
- URL: https://github.com/opera7133/vnovel
- Owner: opera7133
- License: mit
- Created: 2021-04-11T09:15:14.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2025-01-30T11:12:04.000Z (10 months ago)
- Last Synced: 2025-08-26T00:34:38.842Z (3 months ago)
- Topics: hugo-site, hugo-theme, tailwind-css
- Language: CSS
- Homepage: https://vnovel.pages.dev
- Size: 1.31 MB
- Stars: 22
- Watchers: 3
- Forks: 9
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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](https://pagespeed.web.dev/analysis/https-vnovel-pages-dev/jryvdmr9ob?form_factor=mobile)
## Installation
### Method 1
Inside the folder of your Hugo site run:
```bash
$ git clone https://github.com/opera7133/vnovel themes/vnovel
```
Updating theme:
```bash
$ cd themes/vnovel
$ git pull
```
### Method 2
Inside the folder of your Hugo site run:
```bash
$ git submodule add https://github.com/opera7133/vnovel.git themes/vnovel
```
Updating theme:
```bash
$ 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.
```bash
$ npm install
```
For more information read the official [setup guide](https://gohugo.io/overview/installing/) 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.
```bash
$ npm run start
```
Now enter `localhost:1313` in the address bar of your browser.
### Build your site
```bash
$ npm run build
```
## Contributing
If you find a bug or have an idea for a feature, feel free to write an [issue](https://github.com/opera7133/vnovel/issues) or make a PR.
## License
This theme is released under the [MIT license](https://github.com/opera7133/vnovel/blob/master/LICENSE).