-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #404 from ualsg/update
Hugoblox update
- Loading branch information
Showing
631 changed files
with
953 additions
and
33,656 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,93 +1,48 @@ | ||
## [Environment Setup](#environment-setup) | ||
# [Hugo Research Group Theme](https://github.com/wowchemy/starter-hugo-research-group) | ||
|
||
1. Refer to `go.mod` for the current wowchemy version in this repository. | ||
2. Refer to the wowchemy release notes for its compatible hugo-extended version. | ||
3. Installed the compatible hugo-extended version. | ||
4. Note for MacOS users: | ||
1. the compatible hugo version is very often a few versions behind of the latest available on Homebrew. While the | ||
later version very often works, it is strongly advisable to start with the specific version | ||
on wowchemy Release note. | ||
2. To look for the previous releases of hugo on homebrew, look for [previous | ||
commits on the homebrew-core repository](https://github.com/Homebrew/homebrew-core/search?q=hugo&type=commits) to download the relevant `hugo.rb`. | ||
3. Run `brew install hugo.rb` to install the specific older version of hugo. | ||
4. Check the installed hugo version by `hugo version`. | ||
6. Clone the [ual.sg repository](#) | ||
7. Cd into the root of the repository folder, run `git checkout master && git pull origin master` to sync the latest content from master branch. | ||
8. Run `hugo -D -F server --disableFastRender --forceSyncStatic --gc --ignoreCache | ||
--panicOnWarning --printPathWarnings --printUnusedTemplates --watch` to build and serve the | ||
website from the local source. All these flags are to ensure to build from changes and not | ||
serving from cache. | ||
9. Check website at [localhost:1313](http://localhost:1313/). Fix error from previous step, if any, before proceeding any further. | ||
[![Screenshot](preview.png)](https://hugoblox.com/hugo-themes/) | ||
|
||
The **Research Group Template** empowers your research group to easily create a beautiful website with a stunning homepage, news, academic publications, events, team profiles, and a contact form. | ||
|
||
## [Development Workflow](#development-workflow) | ||
️**Trusted by 250,000+ researchers, educators, and students.** Highly customizable via the integrated **no-code, widget-based Wowchemy page builder**, making every site truly personalized ⭐⭐⭐⭐⭐ | ||
|
||
1. Clone the [ual.sg repository](#) | ||
1. Cd into the root of the repository folder, run `git checkout master && git pull origin master` to sync the latest content from master branch. | ||
1. Run `hugo -D -F server --disableFastRender` to build and serve the website from local source | ||
1. Check website at [localhost:1313](http://localhost:1313/) | ||
1. When ready to start making changes, make sure to create a new git branch by `git checkout -b {new-branch-name}` | ||
1. Constantly save and preserve work in progress by committing to the branch and push to github `git push origin {new-branch-name}`. | ||
1. Create a pull request and wait for conflict checks to complete. Netlify will provide a link to preview the website in progress. | ||
1. Make any other necessary changes, review the preview site until it's satisfactory. | ||
1. When content is ready to be published publicly, merge the pull request to `master` branch. | ||
1. Wait for Netlify to publish to the production site, and check for new content. | ||
[![Get Started](https://img.shields.io/badge/-Get%20started-ff4655?style=for-the-badge)](https://hugoblox.com/hugo-themes/) | ||
[![Discord](https://img.shields.io/discord/722225264733716590?style=for-the-badge)](https://discord.com/channels/722225264733716590/742892432458252370/742895548159492138) | ||
[![Twitter Follow](https://img.shields.io/twitter/follow/GetResearchDev?label=Follow%20on%20Twitter)](https://twitter.com/wowchemy) | ||
|
||
## [Development Dos and Don'ts](#development-dos-and-donts) | ||
Easily write technical content with plain text Markdown, LaTeX math, diagrams, RMarkdown, or Jupyter, and import publications from BibTeX. | ||
|
||
### Dos | ||
[Check out the latest demo](https://research-group.netlify.app/) of what you'll get in less than 60 seconds, or [view the showcase](https://hugoblox.com/creators/). | ||
|
||
1. Refer to [Hugo documentation](https://gohugo.io/documentation/) to get a basic understanding of archetypes, taxonomies, and content management | ||
2. Refer to [Wowchemy documentation](https://wowchemy.com/docs/) on modifications and customization to the theme | ||
3. Refer to [Hugo commands](https://gohugo.io/commands/) to learn how to add new content and configure the website | ||
4. Follow the [development workflow](#development-workflow) below | ||
5. When creating new blog posts, follow the title, structure and other things from previous blog posts (check `content/post`). | ||
6. Set `draft: true` in the header of content you don't want to have published at this point. | ||
7. Remember to include any images, external files that is relevant to the content being added, for some may have a global `.gitignore` that prevents detection of those files | ||
8. Make sure to always check for updates from the master branch for merged changes, `git checkout master && git pull origin master` | ||
9. Any customizations of styles shall be made by additing the style specifications to the | ||
`assets/scss/custom.scss` file. | ||
The integrated [**Wowchemy**](https://hugoblox.com) website builder and CMS makes it easy to create a beautiful website for free. Edit your site in the CMS (or your favorite editor), generate it with [Hugo](https://github.com/gohugoio/hugo), and deploy with GitHub or Netlify. Customize anything on your site with widgets, light/dark themes, and language packs. | ||
|
||
### Don'ts | ||
- 👉 [**Get Started**](https://hugoblox.com/hugo-themes/) | ||
- 📚 [View the **documentation**](https://docs.hugoblox.com/) | ||
- 💬 [Chat with the **Wowchemy research community**](https://discord.gg/z8wNYzb) or [**Hugo community**](https://discourse.gohugo.io) | ||
- ⬇️ **Automatically import citations from BibTeX** with the [Hugo Academic CLI](https://github.com/GetRD/academic-file-converter) | ||
- 🐦 Share your new site with the community: [@wowchemy](https://twitter.com/wowchemy) [@GeorgeCushen](https://twitter.com/GeorgeCushen) [#MadeWithWowchemy](https://twitter.com/search?q=%23MadeWithWowchemy&src=typed_query) | ||
- 🗳 [Take the survey and help us improve #OpenSource](https://forms.gle/NioD9VhUg7PNmdCAA) | ||
- 🚀 [Contribute improvements](https://github.com/HugoBlox/hugo-blox-builder/blob/main/CONTRIBUTING.md) or [suggest improvements](https://github.com/HugoBlox/hugo-blox-builder/issues) | ||
- ⬆️ **Updating?** View the [Update Guide](https://docs.hugoblox.com/hugo-tutorials/update/) and [Release Notes](https://github.com/HugoBlox/hugo-blox-builder/releases) | ||
|
||
- DO NOT check-in `public` and `resources` to the git repository | ||
- DO NOT modify the other original stylesheets in `assets/scss/`. You'd thank youself when performing wowchemy updates in the future. | ||
## We ask you, humbly, to support this open source movement | ||
|
||
## [Additional notes](#additional-notes) | ||
Today we ask you to defend the open source independence of the Wowchemy website builder and themes 🐧 | ||
|
||
### Importing Bibtext | ||
We're an open source movement that depends on your support to stay online and thriving, but 99.9% of our creators don't give; they simply look the other way. | ||
|
||
Importing our publications is a bit tricky, the process will be simplified | ||
in the future. In short, update the `data/publications.bib` file and then run `academic import --bibtex publications.bib`. Install academic by with Pip or other python package manager, ie. `pip3 install -U academic`. Futher details refer to [Publications section](https://wowchemy.com/docs/content/publications/). | ||
### [❤️ Click here to become a GitHub Sponsor, unlocking awesome perks such as _exclusive academic templates and widgets_](https://github.com/sponsors/gcushen) | ||
|
||
### Updating Wowchemy | ||
The update wowchemy with newer releases must be performed on each newer release, chronologically | ||
from older to newest. For example, to update from v5.2.0 to v5.5.0, one must update in these | ||
sequences: v5.2.0 -> v.5.3.0, v5.3.0 -> v5.4.0 and finally v5.4.0 to v5.5.0. | ||
## Demo credits | ||
|
||
There are two path options to perform updates. | ||
Please replace the demo images with your own. | ||
|
||
#### Option 1: | ||
1. Clone the latest content from this [ual.sg repository](https://github.com/ualsg/ualsg.netlify.app), as local dev folder. | ||
2. Make a copy of the clone from above, as local ref folder (to refer to current settings | ||
configurations and content from). | ||
3. Clone the next release of [wowchemy repository](https://github.com/wowchemy/wowchemy-hugo-themes). | ||
4. Copy the content of archetypes, assets, config, content, data, layout from the new release | ||
of wowchemy to local dev folder | ||
5. Expect and fix any build errors, build site, review changes and make necessary adjustments | ||
6. Any styles from previous releases that wants to be retained should be moved to the | ||
`assets/scss/custom.scss` file. | ||
|
||
#### Option 2: | ||
1. Clone the next release of [wowchemy repository](https://github.com/wowchemy/wowchemy-hugo-themes). | ||
2. Copy the content [`starters/academic`](https://github.com/wowchemy/wowchemy-hugo-themes/tree/main/starters/academic) to a new local dev folder. | ||
3. Clone the latest content from this [ual.sg repository](https://github.com/ualsg/ualsg.netlify.app) as local ref folder. | ||
4. Copy the configurations and content from local ref folder to local dev folder. | ||
5. Expect and fix any build errors, build site, review changes and make necessary adjustments | ||
6. Any styles from previous releases that wants to be retained should be moved to the | ||
`assets/scss/custom.scss` file. | ||
|
||
### Other Useful Resources: | ||
- [Git and GitHub Tutorial](https://www.freecodecamp.org/news/git-and-github-for-beginners/) | ||
- [Netlify with GitHub](https://www.netlify.com/blog/2016/09/29/a-step-by-step-guide-deploying-on-netlify/) | ||
- [Netlify Documentations](https://docs.netlify.com/) | ||
- [Female scientist](https://unsplash.com/photos/uVnRa6mOLOM) | ||
- [2 Coders](https://unsplash.com/photos/kwzWjTnDPLk) | ||
- [Cafe](https://unsplash.com/photos/RnDGGnMEOao) | ||
- Blog posts | ||
- https://unsplash.com/photos/AndE50aaHn4 | ||
- https://unsplash.com/photos/OYzbqk2y26c | ||
- Avatars | ||
- https://unsplash.com/photos/5yENNRbbat4 | ||
- https://unsplash.com/photos/WNoLnJo7tS8 |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
Binary file not shown.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.