diff --git a/exampleSite/content/_index.md b/exampleSite/content/_index.md index 95f7b53e..f6858310 100755 --- a/exampleSite/content/_index.md +++ b/exampleSite/content/_index.md @@ -3,13 +3,16 @@ title: "Welcome to Blowfish! :tada:" description: "This page was built using the Blowfish theme for Hugo." --- -Welcome to Blowfish, one of the most flexible and robust Hugo themes. It is designed to be simple, fast and content-focused. Learn how to get started: +Welcome to Blowfish, one of the most flexible and robust Hugo themes. It is designed to be simple, fast and content-focused. Learn more about how to install [here]({{< ref "docs/installation" >}}) or get started with our CLI using: -{{< article link="/docs/installation/" >}} +```node +npx blowfish-tools +``` + -You can also find the complete theme documentation in [docs]({{< ref "docs" >}}). Blowfish is highly customizable and can be configured to fit your needs: from a static website to a blog. Checkout some [examples](/examples) and what some of our [users](/users) have been building. +
diff --git a/exampleSite/content/docs/configuration/index.md b/exampleSite/content/docs/configuration/index.md index 75fd9ed1..4f2b7fe0 100644 --- a/exampleSite/content/docs/configuration/index.md +++ b/exampleSite/content/docs/configuration/index.md @@ -13,6 +13,13 @@ Blowfish is a highly customisable theme and uses some of the latest Hugo feature The theme ships with a default configuration that gets you up and running with a basic blog or static website. +{{< alert "fire" >}} +We just launched a CLI tool to help you get started with Blowfish. It will help you with installation and configuration. Install the CLI tool globally using: +```bash +npx blowfish-tools +``` +{{< /alert >}} + > Configuration files bundled with the theme are provided in TOML format as this is the default Hugo syntax. Feel free to convert your config to YAML or JSON if you wish. The default theme configuration is documented in each file so you can freely adjust the settings to meet your needs. diff --git a/exampleSite/content/docs/getting-started/index.md b/exampleSite/content/docs/getting-started/index.md index 6d888235..8998f223 100644 --- a/exampleSite/content/docs/getting-started/index.md +++ b/exampleSite/content/docs/getting-started/index.md @@ -13,6 +13,15 @@ series_order: 3 This section assumes you have already [installed the Blowfish theme]({{< ref "docs/installation" >}}). {{< /alert >}} +
+{{< alert "fire" >}} +We just launched a CLI tool to help you get started with Blowfish. It will help you with installation and configuration. Install the CLI tool globally using: +```bash +npx blowfish-tools +``` +{{< /alert >}} + + The config files that ship with Blowfish contain all of the possible settings that the theme recognises. By default, many of these are commented out but you can simply uncomment them to activate or change a specific feature. ## Basic configuration diff --git a/exampleSite/content/docs/installation/index.md b/exampleSite/content/docs/installation/index.md index bc019f21..fd367e8b 100644 --- a/exampleSite/content/docs/installation/index.md +++ b/exampleSite/content/docs/installation/index.md @@ -27,11 +27,16 @@ Make sure you are using **Hugo version 0.87.0** or later as the theme takes adva You can find detailed installation instructions for your platform in the [Hugo docs](https://gohugo.io/getting-started/installing). -### Install with Blowfish Tools (Beta) +### Blowfish Tools (recommended) 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 +npx blowfish-tools +``` +or + ```shell npm i -g blowfish-tools ``` @@ -46,6 +51,10 @@ You can also run the command `blowfish-tools new` to create a new Hugo project a blowfish-tools new mynewsite ``` +Here's a quick video of how fast it is to get started with Blowfish using the CLI tool: + + + ### Install Manually #### Create a new site diff --git a/exampleSite/content/users/datatodroids.tech/feature.jpg b/exampleSite/content/users/datatodroids.tech/feature.jpg new file mode 100644 index 00000000..7dc7d2f3 Binary files /dev/null and b/exampleSite/content/users/datatodroids.tech/feature.jpg differ diff --git a/exampleSite/content/users/datatodroids.tech/index.md b/exampleSite/content/users/datatodroids.tech/index.md new file mode 100644 index 00000000..b655b673 --- /dev/null +++ b/exampleSite/content/users/datatodroids.tech/index.md @@ -0,0 +1,13 @@ +--- + title: "datatodroids.tech" + tags: [Personal site,Blog] + externalUrl: "https://datatodroids.tech/" + date: 9924-08-08 + showDate: false + showAuthor: false + showReadingTime: false + showEdit: false + showLikes: false + showViews: false + layoutBackgroundHeaderSpace: false + --- diff --git a/exampleSite/content/users/users.json b/exampleSite/content/users/users.json index 056b8075..bd9bcd45 100644 --- a/exampleSite/content/users/users.json +++ b/exampleSite/content/users/users.json @@ -528,5 +528,13 @@ "Personal site", "Blog" ] + }, + { + "title": "datatodroids.tech", + "url": "https://datatodroids.tech/", + "tags": [ + "Personal site", + "Blog" + ] } -] \ No newline at end of file +] diff --git a/package-lock.json b/package-lock.json index 1bd1a480..6d5e8a50 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "hugo-blowfish-theme", - "version": "2.50.0", + "version": "2.51.0", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "hugo-blowfish-theme", - "version": "2.50.0", + "version": "2.51.0", "hasInstallScript": true, "license": "MIT", "dependencies": { @@ -22,14 +22,14 @@ "jquery": "^3.7.1", "katex": "^0.16.9", "packery": "^2.1.2", - "prettier": "^3.1.1", + "prettier": "^3.2.3", "prettier-plugin-go-template": "^0.0.15", "prettier-plugin-tailwindcss": "^0.5.11", "puppeteer": "^21.7.0", "rimraf": "^5.0.5", "tailwindcss": "^3.4.1", "tw-elements": "1.1.0", - "typeit": "^8.8.0", + "typeit": "^8.8.3", "vendor-copy": "^3.0.1" } }, @@ -2031,9 +2031,9 @@ "integrity": "sha512-1NNCs6uurfkVbeXG4S8JFT9t19m45ICnif8zWLd5oPSZ50QnwMfK+H3jv408d4jw/7Bttv5axS5IiHoLaVNHeQ==" }, "node_modules/prettier": { - "version": "3.1.1", - "resolved": "https://registry.npmjs.org/prettier/-/prettier-3.1.1.tgz", - "integrity": "sha512-22UbSzg8luF4UuZtzgiUOfcGM8s4tjBv6dJRT7j275NXsy2jb4aJa4NNveul5x4eqlF1wuhuR2RElK71RvmVaw==", + "version": "3.2.3", + "resolved": "https://registry.npmjs.org/prettier/-/prettier-3.2.3.tgz", + "integrity": "sha512-QNhUTBq+mqt1oH1dTfY3phOKNhcDdJkfttHI6u0kj7M2+c+7fmNKlgh2GhnHiqMcbxJ+a0j2igz/2jfl9QKLuw==", "dev": true, "bin": { "prettier": "bin/prettier.cjs" @@ -2952,9 +2952,9 @@ } }, "node_modules/typeit": { - "version": "8.8.0", - "resolved": "https://registry.npmjs.org/typeit/-/typeit-8.8.0.tgz", - "integrity": "sha512-GQp6OW7vxro1HN3F7UPL0C2KzkGs8bFtUgmJSeK+xNhdofI40mkWxrBT2AXQwtS5Txkg7ttwplxvWCQxnUXyrw==", + "version": "8.8.3", + "resolved": "https://registry.npmjs.org/typeit/-/typeit-8.8.3.tgz", + "integrity": "sha512-K7nChkj6iyylUi713VBDULUXXLF0pfB6nFPVhNnXTKO2An7NzVz5fjoAHk2FAC3TFLiSnU+QsqhDmap17oBELw==", "dev": true, "hasInstallScript": true, "dependencies": { diff --git a/package.json b/package.json index 73f2dc90..7bcfb7ef 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "hugo-blowfish-theme", - "version": "2.50.0", + "version": "2.51.0", "description": "Blowfish theme for Hugo", "scripts": { "postinstall": "vendor-copy", @@ -40,14 +40,14 @@ "jquery": "^3.7.1", "katex": "^0.16.9", "packery": "^2.1.2", - "prettier": "^3.1.1", + "prettier": "^3.2.3", "prettier-plugin-go-template": "^0.0.15", "prettier-plugin-tailwindcss": "^0.5.11", "puppeteer": "^21.7.0", "rimraf": "^5.0.5", "tailwindcss": "^3.4.1", "tw-elements": "1.1.0", - "typeit": "^8.8.0", + "typeit": "^8.8.3", "vendor-copy": "^3.0.1" }, "vendorCopy": [],