feat: rename repo to wowchemy-hugo-themes

Except repo name in module names as that would be a breaking change
This commit is contained in:
George Cushen 2021-10-04 12:18:12 +01:00
commit 64c3c7e8a2
26 changed files with 59 additions and 55 deletions

View file

@ -12,7 +12,7 @@ We use GitHub only for bug reports and feature requests - it's our project manag
🚑 For **help** and **questions**, solve common issues with the [Troubleshooting Guide](https://wowchemy.com/docs/guide/troubleshooting/).
For other issues, search if your question has already been asked on the community **[chat](https://discord.gg/z8wNYzb)** and **[forum](https://github.com/wowchemy/wowchemy-hugo-modules/discussions)**, and if not, consider posting a new thread there.
For other issues, search if your question has already been asked on the community **[chat](https://discord.gg/z8wNYzb)** and **[forum](https://github.com/wowchemy/wowchemy-hugo-themes/discussions)**, and if not, consider posting a new thread there.
Also, you can search and browse the extensive [Wowchemy](https://wowchemy.com/docs/) and [Hugo](https://gohugo.io/documentation/) **documentation**.

View file

@ -4,7 +4,7 @@ contact_links:
url: https://wowchemy.com/docs/faq/
about: Solve common issues fast.
- name: Questions and Discussions
url: https://github.com/wowchemy/wowchemy-hugo-modules/discussions
url: https://github.com/wowchemy/wowchemy-hugo-themes/discussions
about: Please ask and answer questions here.
- name: Chat with the Community
url: https://discord.gg/z8wNYzb

View file

@ -12,13 +12,13 @@ Join the **Contributing** channel on the **[community Discord](https://discord.g
Learn [how to contribute code on Github](https://codeburst.io/a-step-by-step-guide-to-making-your-first-github-contribution-5302260a2940).
If you're a developer looking to contribute, but you're not sure where to begin, check out the [good first issue](https://github.com/wowchemy/wowchemy-hugo-modules/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22) label on Github, which contains small tasks that have been specifically flagged as being friendly to new contributors.
If you're a developer looking to contribute, but you're not sure where to begin, check out the [good first issue](https://github.com/wowchemy/wowchemy-hugo-themes/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22) label on Github, which contains small tasks that have been specifically flagged as being friendly to new contributors.
After that, if you're looking for something a little more challenging to sink your teeth into, there's a broader [help wanted](https://github.com/wowchemy/wowchemy-hugo-modules/labels/help%20wanted) label encompassing issues which need some love.
After that, if you're looking for something a little more challenging to sink your teeth into, there's a broader [help wanted](https://github.com/wowchemy/wowchemy-hugo-themes/labels/help%20wanted) label encompassing issues which need some love.
If you have a straightforward bug fix or improvement, feel free to contribute it in a [Pull Request](https://github.com/wowchemy/wowchemy-hugo-modules/pulls) for the community to review.
If you have a straightforward bug fix or improvement, feel free to contribute it in a [Pull Request](https://github.com/wowchemy/wowchemy-hugo-themes/pulls) for the community to review.
If you have an idea for a new feature, please start by [searching the issues](https://github.com/wowchemy/wowchemy-hugo-modules/issues) to check that the feature has not already been suggested and then suggest it by [opening a new issue](https://github.com/wowchemy/wowchemy-hugo-modules/issues/new/choose), as adding new features to Wowchemy first requires some analysis around the design and spec.
If you have an idea for a new feature, please start by [searching the issues](https://github.com/wowchemy/wowchemy-hugo-themes/issues) to check that the feature has not already been suggested and then suggest it by [opening a new issue](https://github.com/wowchemy/wowchemy-hugo-themes/issues/new/choose), as adding new features to Wowchemy first requires some analysis around the design and spec.
Code linting and formatting form part of the Continuous Integration process to help catch bugs and code issues in contributions.
@ -40,7 +40,7 @@ yarn run format
### Contribute a language pack
To contribute a **new language pack** or an improvement to a language pack, refer to the [language pack guide](https://wowchemy.com/docs/language/#create-or-modify-a-language-pack). Once created, [fork Wowchemy Hugo Modules](https://github.com/wowchemy/wowchemy-hugo-modules), place your language pack in `wowchemy/i18n/`, add the name of the language to `wowchemy/data/i18n/language.yaml`, and open a Pull Request on Github with these two files.
To contribute a **new language pack** or an improvement to a language pack, refer to the [language pack guide](https://wowchemy.com/docs/language/#create-or-modify-a-language-pack). Once created, [fork Wowchemy Hugo Modules](https://github.com/wowchemy/wowchemy-hugo-themes), place your language pack in `wowchemy/i18n/`, add the name of the language to `wowchemy/data/i18n/language.yaml`, and open a Pull Request on Github with these two files.
### Contribute a theme pack
@ -65,8 +65,8 @@ To help us develop this free software sustainably under the open source license,
If you're not a developer there are still plenty of ways that you can help. We always need help with:
- Helping the Wowchemy community on the [chat](https://discord.gg/z8wNYzb) and [forum](https://github.com/wowchemy/wowchemy-hugo-modules/discussions)
- Investigating and reviewing open [Issues](https://github.com/wowchemy/wowchemy-hugo-modules/issues) and [Pull Requests](https://github.com/wowchemy/wowchemy-hugo-modules/pulls)
- Helping the Wowchemy community on the [chat](https://discord.gg/z8wNYzb) and [forum](https://github.com/wowchemy/wowchemy-hugo-themes/discussions)
- Investigating and reviewing open [Issues](https://github.com/wowchemy/wowchemy-hugo-themes/issues) and [Pull Requests](https://github.com/wowchemy/wowchemy-hugo-themes/pulls)
- Give a thumbs up 👍 to upvote a feature request you would like to use
- Improving the [documentation](https://wowchemy.com/docs/) and writing tutorials
- Just click the _Edit_ button at the bottom of pages or open an issue with your proposed improvement

2
.github/support.md vendored
View file

@ -2,7 +2,7 @@
🚑 For **help** and **questions**, solve common issues with the [**Troubleshooting Guide**](https://wowchemy.com/docs/guide/troubleshooting/).
For other issues, search if your question has already been asked on the community **[chat](https://discord.gg/z8wNYzb)** and **[forum](https://github.com/wowchemy/wowchemy-hugo-modules/discussions)**, and if not, consider posting a new thread there.
For other issues, search if your question has already been asked on the community **[chat](https://discord.gg/z8wNYzb)** and **[forum](https://github.com/wowchemy/wowchemy-hugo-themes/discussions)**, and if not, consider posting a new thread there.
Please **_do not_** raise an issue on GitHub.

View file

@ -1,6 +1,6 @@
[中文](https://wowchemy.com/zh/)
<p align="center"><a href="https://wowchemy.com/templates/" target="_blank" rel="noopener"><img src="https://wowchemy.com/media/sharing.png" alt="Wowchemy Website Builder"></a></p>
<p align="center"><a href="https://wowchemy.com/hugo-themes/" target="_blank" rel="noopener"><img src="https://wowchemy.com/media/sharing.png" alt="Wowchemy Website Builder"></a></p>
# [Wowchemy](https://wowchemy.com): the website builder for [Hugo](https://gohugo.io)
@ -12,13 +12,13 @@
🛋 **3. Write from your sofa or on the go with the integrated open source Content Management System (CMS)**
[Check out the latest **demos**](https://wowchemy.com/templates/) of what you'll get in less than 10 minutes, or [get **inspired**](https://wowchemy.com/user-stories/) by user stories.
[Check out the latest **demos**](https://wowchemy.com/hugo-themes/) of what you'll get in less than 10 minutes, or [get **inspired**](https://wowchemy.com/user-stories/) by user stories.
- 👉 [**Get Started**](https://wowchemy.com/templates/)
- 👉 [**Get Started**](https://wowchemy.com/hugo-themes/)
- 📚 [View the **documentation**](https://wowchemy.com/docs/)
- 💬 [Chat with the **Wowchemy community**](https://discord.gg/z8wNYzb) or [**Hugo community**](https://discourse.gohugo.io)
- 🐦 Twitter: [@wowchemy](https://twitter.com/wowchemy) [@GeorgeCushen](https://twitter.com/GeorgeCushen) [#MadeWithWowchemy](https://twitter.com/search?q=%28%23MadeWithWowchemy%20OR%20%23MadeWithAcademic%29&src=typed_query)
- 💡 [Request a **feature** or report a **bug** for _Wowchemy_](https://github.com/wowchemy/wowchemy-hugo-modules/issues)
- 💡 [Request a **feature** or report a **bug** for _Wowchemy_](https://github.com/wowchemy/wowchemy-hugo-themes/issues)
- ⬆️ **Updating Wowchemy?** View the [Update Guide](https://wowchemy.com/docs/update/) and [Release Notes](https://wowchemy.com/updates/)
## Crowd-funded open-source software
@ -34,14 +34,14 @@ To help us develop this template and software sustainably under the MIT license,
## Features
[![Screenshot](https://raw.githubusercontent.com/wowchemy/wowchemy-hugo-modules/main/academic.png)](https://wowchemy.com)
[![Screenshot](https://raw.githubusercontent.com/wowchemy/wowchemy-hugo-themes/main/academic.png)](https://wowchemy.com)
**Key features:**
- **Page builder** - Create _anything_ with [**widgets**](https://wowchemy.com/docs/page-builder/) and [**elements**](https://wowchemy.com/docs/content/writing-markdown-latex/)
- **Edit any type of content** - Blog posts, publications, talks, slides, projects, and more!
- **Create content** in [**Markdown**](https://wowchemy.com/docs/writing-markdown-latex/), [**Jupyter**](https://wowchemy.com/docs/import/jupyter/), or [**RStudio**](https://wowchemy.com/docs/install-locally/)
- **Plugin System** - Fully customizable [**color** and **font themes**](https://wowchemy.com/templates/)
- **Plugin System** - Fully customizable [**color** and **font themes**](https://wowchemy.com/hugo-themes/)
- **Display Code and Math** - Code highlighting and [LaTeX math](https://en.wikibooks.org/wiki/LaTeX/Mathematics) supported
- **Integrations** - [Google Analytics](https://analytics.google.com), [Disqus commenting](https://disqus.com), Maps, Contact Forms, and more!
- **Beautiful Site** - Simple and refreshing one page design
@ -56,13 +56,13 @@ To help us develop this template and software sustainably under the MIT license,
## Themes
Wowchemy comes with **automatic day (light) and night (dark) mode** built-in. Alternatively, click the moon icon in the top right of one of the [Demos](https://wowchemy.com/templates/) to set your preferred mode!
Wowchemy comes with **automatic day (light) and night (dark) mode** built-in. Alternatively, click the moon icon in the top right of one of the [Demos](https://wowchemy.com/hugo-themes/) to set your preferred mode!
Choose a stunning theme for your site and [customize it](https://wowchemy.com/docs/customization/#custom-theme) to your liking:
[![Themes](https://raw.githubusercontent.com/wowchemy/wowchemy-hugo-modules/main/themes.png)](https://wowchemy.com/templates/)
[![Themes](https://raw.githubusercontent.com/wowchemy/wowchemy-hugo-themes/main/themes.png)](https://wowchemy.com/hugo-themes/)
[Browse more templates and themes...](https://wowchemy.com/templates/)
[Browse more templates and themes...](https://wowchemy.com/hugo-themes/)
## The Future of Technical Content Writing
@ -70,12 +70,12 @@ Choose a stunning theme for your site and [customize it](https://wowchemy.com/do
## Join the community
Feel free to _star_ the project on [Github](https://github.com/wowchemy/wowchemy-hugo-modules), [join the community](https://discord.gg/z8wNYzb) on Discord, and follow [@wowchemy](https://twitter.com/wowchemy) on Twitter to be the first to hear about new features.
Feel free to [_star_ the project on Github](https://github.com/wowchemy/wowchemy-hugo-themes), [join the community](https://discord.gg/z8wNYzb) on Discord, and follow [@wowchemy](https://twitter.com/wowchemy) on Twitter to be the first to hear about new features.
## License
Copyright 2016-present [George Cushen](https://georgecushen.com).
Released under the [MIT](https://github.com/wowchemy/wowchemy-hugo-modules/blob/main/LICENSE.md) license.
The [Wowchemy Hugo Themes](https://github.com/wowchemy/wowchemy-hugo-themes/) repository is released under the [MIT](https://github.com/wowchemy/wowchemy-hugo-themes/blob/main/LICENSE.md) license.
[![Analytics](https://ga-beacon.appspot.com/UA-78646709-2/wowchemy-hugo-modules/readme?pixel)](https://github.com/igrigorik/ga-beacon)
[![Analytics](https://ga-beacon.appspot.com/UA-78646709-2/wowchemy-hugo-themes/readme?pixel)](https://github.com/igrigorik/ga-beacon)

View file

@ -5,12 +5,12 @@
"author": "George Cushen",
"license": "MIT",
"bugs": {
"url": "https://github.com/wowchemy/wowchemy-hugo-modules/issues"
"url": "https://github.com/wowchemy/wowchemy-hugo-themes/issues"
},
"homepage": "https://wowchemy.com",
"repository": {
"type": "git",
"url": "git+https://github.com/wowchemy/wowchemy-hugo-modules.git"
"url": "git+https://github.com/wowchemy/wowchemy-hugo-themes.git"
},
"main": "index.js",
"dependencies": {

View file

@ -2,4 +2,4 @@
# Generate preprocessed resources for demo site whilst also removing disused resources.
# Run this script from the root Wowchemy dir.
HUGO_THEME=wowchemy-hugo-modules hugo --source exampleSite --themesDir ../../ --gc
HUGO_THEME=wowchemy-hugo-themes hugo --source exampleSite --themesDir ../../ --gc

4
scripts/rm_hugo_cache.sh Normal file
View file

@ -0,0 +1,4 @@
#!/usr/bin/env bash
# Clear Hugo's cache on MacOS (assumes default path)
sudo rm -rf $TMPDIR/hugo_cache/

View file

@ -2,7 +2,7 @@
# View the demo site on any local devices by binding the local IP on port 1315.
# Run this script from the root Wowchemy dir.
HUGO_THEME=wowchemy-hugo-modules hugo \
HUGO_THEME=wowchemy-hugo-themes hugo \
--source exampleSite --themesDir ../../ \
--bind=0.0.0.0 -p 1315 --baseURL=http://0.0.0.0:1315 \
--i18n-warnings --minify -e "development" \

View file

@ -1,6 +1,7 @@
---
# Generate Wowchemy CMS
type: wowchemycms
private: true
outputs:
- wowchemycms_config
- HTML

View file

@ -3,7 +3,7 @@
"version": "0.0.1",
"description": "Wowchemy Test Build",
"main": "",
"repository": "https://github.com/wowchemy/wowchemy-hugo-modules",
"repository": "https://github.com/wowchemy/wowchemy-hugo-themes",
"author": "George Cushen",
"license": "MIT",
"private": true,

View file

@ -6,15 +6,13 @@ Built upon the open source [Netlify CMS](https://www.netlifycms.org/) and [Netli
## Install
1. Edit `config/_default/config.toml` to install the `wowchemy-cms` Hugo Module so that you have something like:
1. Edit `config/_default/config.yaml` to install the `wowchemy-cms` Hugo Module so that you have something like:
```toml
[module]
# Any existing modules here...
[[module.imports]]
path = "github.com/wowchemy/wowchemy-hugo-modules/wowchemy-cms"
[[module.imports]]
path = "github.com/wowchemy/wowchemy-hugo-modules/wowchemy"
```yaml
module:
imports:
- path: github.com/wowchemy/wowchemy-hugo-modules/wowchemy-cms/v5
- path: github.com/wowchemy/wowchemy-hugo-modules/wowchemy/v5
```
2. Create a `content/admin/index.md` file containing:
@ -22,6 +20,7 @@ Built upon the open source [Netlify CMS](https://www.netlifycms.org/) and [Netli
```yaml
---
type: wowchemycms
private: true
outputs:
- wowchemycms_config
- HTML
@ -29,9 +28,9 @@ Built upon the open source [Netlify CMS](https://www.netlifycms.org/) and [Netli
```
3. (Optional) If your Git repository's branch is **not** `main`, define it in `config/_default/params.toml`:
3. (Optional) If your Git repository's branch is **not** `main`, define it in `config/_default/params.yaml`:
```toml
[cms]
branch = "master"
```yaml
cms:
branch: master
```

View file

@ -1,6 +1,6 @@
/*************************************************
* Wowchemy
* https://github.com/wowchemy/wowchemy-hugo-modules
* https://github.com/wowchemy/wowchemy-hugo-themes
*
* Algolia based search algorithm.
**************************************************/

View file

@ -1,6 +1,6 @@
/*************************************************
* Wowchemy
* https://github.com/wowchemy/wowchemy-hugo-modules
* https://github.com/wowchemy/wowchemy-hugo-themes
*
* Wowchemy Animation
**************************************************/

View file

@ -1,6 +1,6 @@
/*************************************************
* Wowchemy
* https://github.com/wowchemy/wowchemy-hugo-modules
* https://github.com/wowchemy/wowchemy-hugo-themes
*
* Wowchemy Initialization
**************************************************/

View file

@ -1,6 +1,6 @@
/*************************************************
* Wowchemy
* https://github.com/wowchemy/wowchemy-hugo-modules
* https://github.com/wowchemy/wowchemy-hugo-themes
*
* In-built Fuse based search algorithm.
**************************************************/

View file

@ -1,6 +1,6 @@
/*************************************************
* Wowchemy
* https://github.com/wowchemy/wowchemy-hugo-modules
* https://github.com/wowchemy/wowchemy-hugo-themes
*
* Wowchemy Theming System
* Supported Modes: {0: Light, 1: Dark, 2: Auto}

View file

@ -1,6 +1,6 @@
/*************************************************
* Wowchemy
* https://github.com/wowchemy/wowchemy-hugo-modules
* https://github.com/wowchemy/wowchemy-hugo-themes
*
* Wowchemy Utilities
**************************************************/

View file

@ -1,6 +1,6 @@
/*************************************************
* Wowchemy
* https://github.com/wowchemy/wowchemy-hugo-modules
* https://github.com/wowchemy/wowchemy-hugo-themes
*
* Core JS functions and initialization.
**************************************************/

View file

@ -2,7 +2,7 @@
* Wowchemy: The Website Builder for Hugo
* Designed by @GeorgeCushen
* https://wowchemy.com/
* License: https://github.com/wowchemy/wowchemy-hugo-modules/blob/main/LICENSE.md
* License: https://github.com/wowchemy/wowchemy-hugo-themes/blob/main/LICENSE.md
**************************************************/
@import 'helpers/all';

View file

@ -11,7 +11,7 @@
{{/* Initialise Wowchemy. */}}
{{ $js_license := printf "/*! Wowchemy v%s | https://wowchemy.com/ */\n" site.Data.wowchemy.version }}
{{ $js_license := $js_license | printf "%s/*! Copyright 2016-present George Cushen (https://georgecushen.com/) */\n" }}
{{ $js_license := $js_license | printf "%s/*! License: https://github.com/wowchemy/wowchemy-hugo-modules/blob/main/LICENSE.md */\n" }}
{{ $js_license := $js_license | printf "%s/*! License: https://github.com/wowchemy/wowchemy-hugo-themes/blob/main/LICENSE.md */\n" }}
{{ $js_bundle_head := $js_license | resources.FromString "js/bundle-head.js" }}
{{ $wcDarkLightEnabled := site.Params.day_night | default false }}
{{ $wcIsSiteThemeDark := not (.Scratch.Get "light") | default false }}

View file

@ -44,7 +44,7 @@
{{ $i18n_published_with = $default }}
{{ end }}
{{ $i18n_published_with = replace $i18n_published_with "{wowchemy}" "<a href=\"https://wowchemy.com/?utm_campaign=poweredby\" target=\"_blank\" rel=\"noopener\">Wowchemy</a>" | safeHTML }}
{{ $i18n_published_with = replace $i18n_published_with "{repo_link}" "<a href=\"https://github.com/wowchemy/wowchemy-hugo-modules\" target=\"_blank\" rel=\"noopener\">" | safeHTML }}
{{ $i18n_published_with = replace $i18n_published_with "{repo_link}" "<a href=\"https://github.com/wowchemy/wowchemy-hugo-themes\" target=\"_blank\" rel=\"noopener\">" | safeHTML }}
{{ $i18n_published_with = replace $i18n_published_with "{/repo_link}" "</a>" | safeHTML }}
{{ $i18n_published_with | markdownify | emojify }}
{{ end }}

View file

@ -196,7 +196,7 @@
{{ $license := printf "/*! Wowchemy v%s | https://wowchemy.com/ */\n" site.Data.wowchemy.version }}
{{ $license := $license | printf "%s/*! Copyright 2016-present George Cushen (https://georgecushen.com/) */\n" }}
{{ $license := $license | printf "%s/*! License: https://github.com/wowchemy/wowchemy-hugo-modules/blob/main/LICENSE.md */\n" }}
{{ $license := $license | printf "%s/*! License: https://github.com/wowchemy/wowchemy-hugo-themes/blob/main/LICENSE.md */\n" }}
{{ $css_bundle_head := $license | resources.FromString "css/bundle-head.css" }}
{{ $css_options := dict "targetPath" "css/wowchemy.css" }}
{{- if hugo.IsProduction -}}

View file

@ -125,7 +125,7 @@
{{ $js_license := printf "/*! Wowchemy v%s | https://wowchemy.com/ */\n" site.Data.wowchemy.version }}
{{ $js_license := $js_license | printf "%s/*! Copyright 2016-present George Cushen (https://georgecushen.com/) */\n" }}
{{ $js_license := $js_license | printf "%s/*! License: https://github.com/wowchemy/wowchemy-hugo-modules/blob/main/LICENSE.md */\n" }}
{{ $js_license := $js_license | printf "%s/*! License: https://github.com/wowchemy/wowchemy-hugo-themes/blob/main/LICENSE.md */\n" }}
{{ $js_bundle_head := $js_license | resources.FromString "js/bundle-head.js" }}
{{ $js_params := dict "hugoEnvironment" hugo.Environment "codeHighlighting" ($scr.Get "highlight_enabled" | default false) "searchEnabled" (in (slice "wowchemy" "algolia") $search_provider) }}
{{ $js_academic := resources.Get "js/wowchemy.js" | js.Build (dict "targetPath" (printf "%s/js/wow-core.js" .Lang ) "params" $js_params) }}

View file

@ -21,7 +21,7 @@
{{ warnf "Hugo cannot find a Widget Page at %s!" $page }}
{{ warnf "If the page exists, Hugo Server may need restarting due to file changes." }}
{{ warnf "View the Widget Page documentation at https://wowchemy.com/docs/managing-content/#create-a-widget-page ." }}
{{ warnf "If the Hugo version is between 0.65 and 0.68, it may be a confirmed Hugo bug that is expected to be fixed in Hugo v0.69: https://github.com/wowchemy/wowchemy-hugo-modules/issues/1595#issuecomment-605514973 ." }}
{{ warnf "If the Hugo version is between 0.65 and 0.68, it may be a confirmed Hugo bug that is expected to be fixed in Hugo v0.69: https://github.com/wowchemy/wowchemy-hugo-themes/issues/1595#issuecomment-605514973 ." }}
{{ end }}
{{ end }}

View file

@ -1,9 +1,9 @@
name = "Wowchemy Widget Pages"
license = "MIT"
licenselink = "https://github.com/wowchemy/wowchemy-hugo-modules/blob/main/LICENSE.md"
licenselink = "https://github.com/wowchemy/wowchemy-hugo-themes/blob/main/LICENSE.md"
description = "Create any kind of website with fully customizable widgets - 50+ light/dark color themes, language packs, and widgets included."
homepage = "https://github.com/wowchemy/wowchemy-hugo-modules"
demosite = "https://online-fitness-coach.netlify.app/"
homepage = "https://github.com/wowchemy/wowchemy-hugo-themes"
demosite = "https://hugo-academic-pages.netlify.app/"
tags = ["widgets",
"portfolio",
"responsive",