From 1468a0fe7b701e8fb172c656018ba05d53f0ec06 Mon Sep 17 00:00:00 2001 From: yuubinnkyoku <137483288+yuubinnkyoku@users.noreply.github.com> Date: Thu, 5 Dec 2024 06:58:29 +0000 Subject: [PATCH] =?UTF-8?q?README.ja.md=E3=82=92=E8=BF=BD=E5=8A=A0?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.ja.md | 179 ++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 2 +- README.zh-cn.md | 2 +- 3 files changed, 181 insertions(+), 2 deletions(-) create mode 100644 README.ja.md diff --git a/README.ja.md b/README.ja.md new file mode 100644 index 00000000..5b192bf3 --- /dev/null +++ b/README.ja.md @@ -0,0 +1,179 @@ +[English](https://github.com/nunocoracao/blowfish/blob/main/README.md) | [简体中文](https://github.com/nunocoracao/blowfish/blob/main/README.zh-cn.md) | 日本語 +# Blowfish +[![Deploy Production to Firebase](https://github.com/nunocoracao/blowfish/actions/workflows/firebase-production.yml/badge.svg)](https://github.com/nunocoracao/blowfish/actions/workflows/firebase-production.yml) +[![Deploy Production to GitHub pages](https://github.com/nunocoracao/blowfish/actions/workflows/pages.yml/badge.svg)](https://github.com/nunocoracao/blowfish/actions/workflows/pages.yml) +[![Minimum Hugo Version](https://img.shields.io/static/v1?label=min-HUGO-version&message=0.87.0&color=blue&logo=hugo)](https://github.com/gohugoio/hugo/releases/tag/v0.87.0) +[![GitHub](https://img.shields.io/github/license/nunocoracao/blowfish)](https://github.com/nunocoracao/blowfish/blob/main/LICENSE) +[![Blowfish](https://img.shields.io/badge/Hugo--Themes-@Blowfish-blue)](https://themes.gohugo.io/themes/blowfish/) +![code-size](https://img.shields.io/github/languages/code-size/nunocoracao/blowfish) + +Blowfish is designed to be a powerful, lightweight theme for [Hugo](https://gohugo.io). It's built using Tailwind CSS with a clean and minimalist design that prioritises to your content. + +![blowfish screenshot](https://github.com/nunocoracao/blowfish/blob/main/images/screenshot.png?raw=true) + + +🌏 [Demo site](https://blowfish.page/) +📑 [Theme documentation](https://blowfish.page/docs/) +💎 [Merch Store](http://tee.pub/lic/qwSlWVBL5zc) +🐛 [Bug reports & issues](https://github.com/nunocoracao/blowfish/issues) +💡 [Questions & feature requests](https://github.com/nunocoracao/blowfish/discussions) + + + +Buy Me A Coffee + + + + +## Features + +- Fully responsive layout built with Tailwind CSS 3.0 +- Multiple colour schemes (or fully customise your own) +- Dark mode (forced on/off or auto-switching with user toggle) +- Highly customisable configuration +- Firebase integration to support dynamic data +- Views count & like mechanism +- Related articles +- Multiple homepage layouts +- Multiple authors +- Series of articles +- Date and weight based article sorting +- Zen mode for article reading +- Flexible with any content types, taxonomies and menus +- Header and footer menus +- Nested menus & sub-navigation menu +- Scrollable table of contents +- Multilingual content support including support for RTL languages +- Ability to link to posts on third-party websites +- Support for several shortcodes like Gallery, Timeline, GitHub cards, and Carousels +- Buymeacoffee integration +- Client-side site search powered by Fuse.js +- Diagrams and visualisations using Mermaid +- Charts using Chart.js +- TypeIt integration +- Youtube embeds with performance improvements +- Mathematical notation using KaTeX +- SVG icons from FontAwesome 6 +- Automatic image resizing using Hugo Pipes +- Heading anchors, Tables of Contents, Code copy, Buttons, Badges and more +- HTML and Emoji support in articles 🎉 +- SEO friendly with links for sharing to social media +- Fathom Analytics and Google Analytics support +- RSS feeds, Favicons and comments support +- Advanced customisation using simple Tailwind colour definitions and styles +- Optimised for performance and accessibility with perfect Lighthouse scores +- Fully documented with regular updates + +--- + +![blowfish logo](https://github.com/nunocoracao/blowfish/blob/main/logo.png?raw=true) + +## Documentation + +Blowfish has [extensive documentation](https://blowfish.page/docs/) that covers all aspects of the theme. Be sure to [read the docs](https://blowfish.page/docs/) to learn more about how to use the theme and its features. + +--- + +## Installation + +Blowfish supports several installation methods - as a git submodule, a Hugo Module, or as a completely manual install. + +Detailed instructions for each method can be found in the [Installation](https://blowfish.page/docs/installation) docs. You should consult the documentation for the simplest setup experience. Below is a quick start guide using submodules if you are using git, or Hugo modules if you're already confident installing Hugo themes. + +### Quick start using Blowfish Tools + +> **Note:** Ensure you have **Node.js**, **Git**, **Go** and **Hugo** installed, and that you have created a new Hugo project before proceeding. + +We just launched a new CLI tool to help you get started with Blowfish. It will create a new Hugo project, install the theme and set up the theme configuration files for you. It's still in beta so please [report any issues you find](https://github.com/nunocoracao/blowfish-tools). + +Install the CLI tool globally using npm (or other package manager): +```shell +npm i -g blowfish-tools +``` + +Then run the command `blowfish-tools` to start an interactive run which will guide you through creation and configuration use-cases. +```shell +blowfish-tools +``` + +You can also run the command `blowfish-tools new` to create a new Hugo project and install the theme in one go. Check the CLI help for more information. +```shell +blowfish-tools new mynewsite +``` + +### Quick start using git submodules + +> **Note:** Ensure you have **Git**, **Go**, and **Hugo** installed, and that you have created a new Hugo project before proceeding. + +1. From your project directory, initialise git: + + ```shell + git init + ``` + +2. Configure Blowfish as a git submodule: + + ```shell + git submodule add -b main https://github.com/nunocoracao/blowfish.git themes/blowfish + ``` + +3. In the root folder of your website, delete the `config.toml` file that was generated by Hugo. Copy the `*.toml` config files from the theme into your `config/_default/` folder. + + You will find these theme config files in the Hugo cache directory, or [download a copy](https://github.com/nunocoracao/blowfish/releases/latest/download/config-default.zip) from GitHub. + +4. Follow the [Getting Started](https://blowfish.page/docs/getting-started/) instructions to configure your website. + +### Quick start using Hugo + +> **Note:** Ensure you have **Go** and **Hugo** installed, and that you have created a new Hugo project before proceeding. + +1. From your project directory, initialise Hugo Modules: + + ```shell + hugo mod init github.com// + ``` + +2. Create `config/_default/module.toml` and add the following: + + ```toml + [[imports]] + path = "github.com/nunocoracao/blowfish/v2" + ``` + +3. Start your server using `hugo server` and the theme will be downloaded automatically. + +4. In the root folder of your website, delete the `hugo.toml` file that was generated by Hugo. Copy the `*.toml` config files from the theme into your `config/_default/` folder. + + > **Note:** Do not overwrite the `module.toml` file you created above! + + You will find these theme config files in the Hugo cache directory, or [download a copy](https://github.com/nunocoracao/blowfish/releases/latest/download/config-default.zip) from GitHub. + +5. Follow the [Getting Started](https://blowfish.page/docs/getting-started/) instructions to configure your website. + +### Installing theme updates + +As new releases are posted, you can update the theme using Hugo. Simply run `hugo mod get -u` from your project directory and the theme will automatically update to the latest release. + +Detailed [update instructions](https://blowfish.page/docs/installation/#installing-updates) are available in the docs. + +--- + +## Contributing + +Blowfish is expected to evolve over time. I intend to keep adding features and making changes as required. + +Feel free to get in touch with any issues or suggestions for new features you'd like to see. + +- 🐛 **Bug reports & issues:** Use [GitHub Issues](https://github.com/nunocoracao/blowfish/issues) +- 💡 **Ideas for new features:** Open a discussion on [GitHub Discussions](https://github.com/nunocoracao/blowfish/discussions) +- 🙋‍♀️ **General questions:** Head to [GitHub Discussions](https://github.com/nunocoracao/blowfish/discussions) + +If you're able to fix a bug or implement a new feature, I welcome PRs for this purpose. Learn more in the [contributing guidelines](https://github.com/nunocoracao/blowfish/blob/main/CONTRIBUTING.md). + +--- + +## Stargazers over time + +[![Stargazers over time](https://starchart.cc/nunocoracao/blowfish.svg)](https://starchart.cc/nunocoracao/blowfish) + +Mastodon diff --git a/README.md b/README.md index 6c6359fa..235723b0 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -English | [简体中文](https://github.com/nunocoracao/blowfish/blob/main/README.zh-cn.md) +English | [简体中文](https://github.com/nunocoracao/blowfish/blob/main/README.zh-cn.md) | [日本語](https://github.com/nunocoracao/blowfish/blob/main/README.ja.md) # Blowfish [![Deploy Production to Firebase](https://github.com/nunocoracao/blowfish/actions/workflows/firebase-production.yml/badge.svg)](https://github.com/nunocoracao/blowfish/actions/workflows/firebase-production.yml) [![Deploy Production to GitHub pages](https://github.com/nunocoracao/blowfish/actions/workflows/pages.yml/badge.svg)](https://github.com/nunocoracao/blowfish/actions/workflows/pages.yml) diff --git a/README.zh-cn.md b/README.zh-cn.md index e3e5619d..7d652481 100644 --- a/README.zh-cn.md +++ b/README.zh-cn.md @@ -1,4 +1,4 @@ -[English](https://github.com/nunocoracao/blowfish/blob/main/README.md) | 简体中文 +[English](https://github.com/nunocoracao/blowfish/blob/main/README.md) | 简体中文 | [日本語](https://github.com/nunocoracao/blowfish/blob/main/README.ja.md) # Blowfish [![Deploy Production to Firebase](https://github.com/nunocoracao/blowfish/actions/workflows/firebase-production.yml/badge.svg)](https://github.com/nunocoracao/blowfish/actions/workflows/firebase-production.yml) [![Deploy Production to GitHub pages](https://github.com/nunocoracao/blowfish/actions/workflows/pages.yml/badge.svg)](https://github.com/nunocoracao/blowfish/actions/workflows/pages.yml)