Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pacollins/calligraphy
Calligraphy is a theme for Hugo static site generator focused on the beauty of it's content.
https://github.com/pacollins/calligraphy
hugo theme
Last synced: 3 months ago
JSON representation
Calligraphy is a theme for Hugo static site generator focused on the beauty of it's content.
- Host: GitHub
- URL: https://github.com/pacollins/calligraphy
- Owner: pacollins
- License: mit
- Created: 2022-03-25T01:13:39.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-07-14T20:00:32.000Z (7 months ago)
- Last Synced: 2024-08-03T09:12:38.257Z (6 months ago)
- Topics: hugo, theme
- Language: SCSS
- Homepage: https://hugo-calligraphy.netlify.app/
- Size: 28.8 MB
- Stars: 24
- Watchers: 3
- Forks: 7
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://app.netlify.com/sites/hugo-calligraphy/deploys)
> Calligraphy is a theme for Hugo static site generator focused on the beauty of it's content.
## Getting Started
There are two different methods to install the theme depending on how you plan on using it.
### 1. Clone Repository
> I want to use this theme and might want to contribute to it.
Navigate to the root directory of your site and do the following:
```shell
git clone https://github.com/pacollins/calligraphy.git themes/calligraphy
```
### 2. Submodule
> I want to use this theme, but I have no plans to contribute or make a pull request.
Navigate to the root directory of your site and do the following:
```shell
git submodule add https://github.com/pacollins/calligraphy.git themes/calligraphy
git submodule update --init --recursive
```
You should now be able to navigate to `themes/calligraphy` and see all of the theme files.
To update your site to the current version of the theme, navigate to the root directory and do the following:
```shell
git submodule update --remote --merge
```
## Modifying
If you need to customize any aspect of the theme for personal use, simply create a duplicate file at the root directory. *Note:* You do not need to edit the theme files to customize theme. Refer to the Hugo documentation related [lookup order](https://gohugo.io/templates/lookup-order/).
For example, if you wanted to change the template for the header (`/themes/layouts/partials/site/header.html`) you would create a new file at `/layouts/partials/site/header.html` and base it off of the theme file. Hugo will then use your file instead of the theme file. This is the proper way to adjust files for personal use so that you do not make your site incompatible with future versions of the theme.
## `exampleSite`
Within the `calligraphy` folder, you will find another folder called `exampleSite` This folder is what is used to build the [demo](https://hugo-calligraphy.netlify.app/) and should provide you with an example of how to structure your site files.
## Hugo's Built-In Server
To see a live version of your site locally, use the following command:
```shell
hugo server
```
Hugo will build your site and host a server locally. You can view this live at
[localhost:1313](http://localhost:1313).
## About the Author
Calligraphy is a theme created by [Patrick A Collins](https://pacollins.com/)
for [Hugo](https://gohugo.io/). Inspired by its namesake, the theme aims to
provide a simple canvas that is elegant and ensures high readability for all
visitors.
Please also refer to the [project contributors list](https://github.com/pacollins/hugo-future-imperfect-slim/graphs/contributors) for everyone that has directly contributed to this theme.
## License
This theme is released under the [MIT License](https://github.com/pacollins/calligraphy/blob/master/LICENSE). Please read the license for more information.
## Special Thanks
- [Playfair Display Font](https://fonts.google.com/specimen/Playfair+Display)
- [Source Sans Pro Font](https://fonts.google.com/specimen/Source+Sans+Pro)