New theme: viBook

[shunito]

Theme submission

Before submitting a theme please make sure you've read the README.md. It describes in detail what information are needed and which requirements have to be fulfilled for the submission. The check list below can help you.

Link to my theme repository: https://github.com/shunito/vibook

I made sure that...

• the repository contains a good README.md describing my theme
• an open source license has been added to LICENSE.md
• all metadata have been added to theme.toml
• screenshots have been added in the images/ folder with the required dimensions
• in case I'm using a customized demo via the exampleSite folder that
  • https://example.com is set as base url in exampleSite/config.{toml, yaml, json} to avoid the abuse of unused domains
  • I tested that my theme's demo works with the content directory of gohugoio/HugoBasicExample
• I tested my theme against the gohugoio/HugoBasicExample
  • I've checked the developer tools' console in my browser for error messages
• in case my theme is using Hugo Pipes features like toCSS and PostCSS that I have committed the /resources directory with all generated assets, for my theme to work in the basic version of Hugo

Feel free to ask questions. We're glad to help.

[peaceiris]

Awesome theme! ʕ◔ϖ◔ʔ

[digitalcraftsman]

Hello Shunsuke,

thank you for sharing this theme with us 👍

While reviewing your theme I noticed that the generated demo of your theme has some issues with the setup on the hugo theme site. Those issues are related to the way content is linked.

On the Hugo theme site all demos are hosted in a subdirectory, in your case it would be https://themes.gohugo.io/theme/vibook. Currently, all your links are relative to the root directory and miss the subfolder themes in the url above. This causes the reader to fetch non-existing content from the wrong url.

You can recreate the setup of the Hugo theme site by modifying / adding the following lines to exampleSite/config.toml and by starting Hugo inside the exampleSite directory:

# config.toml

baseURL = "http://example.com/theme"
theme = "../.."

Now open the browser with the url http://localhost:1313/theme.

Then you will notice that the first link in the "Vivliostyle プレビュー" section points to a non-existing page. Based on the libraries you're using I'm not sure where it should point to instead.

Let's move to the "ページ個別" section:

When you open the first link a cover should be displayed. However, the pages look either broken or are empty.

When opening the viewer under first link the expected content can't be found because the path provided in the url as parameter isn't correct anymore. A possible fix is to add .. as prefix to the path /theme/cover/cover in the url http://localhost:1313/viewer/#x=/theme/cover/cover such that the get the url http://localhost:1313/viewer/#x=../theme/cover/cover. This worked both with your current setup and with a baseurl that hosts the site in a subfolder (as suggested above by appending /theme to the baseurl in the config file).

Furthermore, please add a translation of the README (at least in an English version) for the international users as you already planned in shunito/vibook#3. The same applies to the demo content provided in exampleSite/content.

[stale]

This issue has been automatically marked as stale because it has not had recent activity. Feel free to ask questions. We're glad to help.
This issue will automatically be closed in the near future if no further activity occurs. Thank you for all your contributions.