dot-hugo/README.md
2022-10-20 16:34:04 +06:00

136 lines
5.5 KiB
Markdown

<h1 align=center>Dot Hugo </h1>
<p align=center>Dot is a simple Hugo documentation theme with a professional outlook. </p>
<h2 align="center"><a target="_blank" href="https://demo.gethugothemes.com/dot" rel="nofollow">Demo</a> | <a target="_blank" href="https://pagespeed.web.dev/report?url=https%3A%2F%2Fdemo.gethugothemes.com%2Fdot%2Fsite%2F&form_factor=desktop">Page Speed (96%)</a> </h2>
<p align=center>
<a href="https://github.com/gohugoio/hugo/releases/tag/v0.64.0" alt="Contributors">
<img src="https://img.shields.io/static/v1?label=min-HUGO-version&message=0.64.0&color=f00&logo=hugo" />
</a>
<a href="https://github.com/themefisher/dot-hugo/blob/master/LICENSE">
<img src="https://img.shields.io/github/license/themefisher/dot-hugo" alt="license"></a>
<img src="https://img.shields.io/github/languages/code-size/themefisher/dot-hugo" alt="code size">
<a href="https://github.com/themefisher/dot-hugo/graphs/contributors">
<img src="https://img.shields.io/github/contributors/themefisher/dot-hugo" alt="contributors"></a>
<a href="https://twitter.com/intent/follow?screen_name=gethugothemes">
<img src="https://img.shields.io/twitter/follow/gethugothemes?style=social&logo=twitter"
alt="follow on Twitter"></a>
</p>
---
<p align="center">
<img src="https://user-images.githubusercontent.com/37659754/54081086-cc7ce200-4328-11e9-9f7d-74d9b32fa68c.gif" alt="screenshot" width="100%">
</p>
---
## Key Features
- Multiple language support (Fr, En)
- Google analytics support
- CSS and Js bundle with hugo pipe
- Color and fonts variable in config file
- Contact form Support
- Google page speed optimized ( 96% )
- Open graph meta tag
- Twitter card meta tag
## Local development
```bash
# clone the repository
git clone git@github.com:themefisher/dot-hugo.git
# cd in the project directory
$ cd dot-hugo/exampleSite/
# Start local dev server
$ hugo server --themesDir ../..
```
Or Check out [Full Documentation](https://docs.gethugothemes.com/dot/?ref=github).
## Content Management System
[![import to
Forestry](https://assets.forestry.io/import-to-forestryK.svg)](https://app.forestry.io/quick-start?repo=themefisher/dot-hugo&engine=hugo&version=0.87.0)
This project has been pre-configured to work with [Forestry](https://forestry.io) a git-based CMS, [import your
repository in Forestry](https://app.forestry.io/quick-start?repo=themefisher/dot-hugo&engine=hugo&version=0.87.0) and
you will be able to edit and preview your site ✨.
Any changes you make in Forestry will be committed back to the repo and deployed if you use [Netlify](#netlify).
## Deployment and hosting
[![Deploy to
Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/themefisher/dot-hugo)
Follow the steps.
## Prefer a video? (Hugo + Netlify + Forestry)
Build your website with **Dot Hugo** theme by following these easy steps (No Coding Required!)
[Video Tutorial](https://youtu.be/ResipmZmpDU).
<!-- reporting issue -->
## Reporting Issues
We use GitHub Issues as the official bug tracker for the dot Template. Please Search [existing
issues](https://github.com/themefisher/dot-hugo/issues). Someone may have already reported the same problem.
If your problem or idea has not been addressed yet, feel free to [open a new
issue](https://github.com/themefisher/dot-hugo/issues).
## Submit Your Website To Our Showcase
Are you using Dot Hugo theme? Submit it to our [showcase](https://gethugothemes.com/showcase).
Our showcase aims to demonstrate to the world what amazing websites people like you have created utilizing our Hugo themes and to show that Hugo has tremendous capabilities as a Static Site Generator.
View all the websites powered by Dot Hugo from [here](https://gethugothemes.com/showcase?theme=dot).
[Submit](https://gethugothemes.com/showcase?submit=show) your Dot Hugo powered website.
<!-- licence -->
## License
Copyright &copy; Designed by [Themefisher](https://themefisher.com) & Developed by
[Gethugothemes](https://gethugothemes.com)
**Code License:** Released under the [MIT](https://github.com/themefisher/dot-hugo/blob/master/LICENSE) license.
**Image license:** The images are only for demonstration purposes. They have their licenses. We don't have permission to
share those images.
<!-- resources -->
## Special Thanks
- [Bootstrap](https://getbootstrap.com)
- [Jquery](https://jquery.com)
- [Themify Icons](https://themify.me/themify-icons)
- [Jquery Match Height](https://brm.io/jquery-match-height/)
- [Google Fonts](https://fonts.google.com/)
- [All Contributors](https://github.com/themefisher/dot-hugo/graphs/contributors)
## Hire Us
Besides developing unique, blazing-fast Hugo themes, we also provide customized services. We specialize in creating affordable, high-quality static websites based on Hugo.
If you need to customize the theme or complete website development from scratch, you can hire us.
Check Our
[Services](https://gethugothemes.com/services/?utm_source=dot_github&utm_medium=referral&utm_campaign=github_theme_readme)
<!-- premium themes -->
## Premium Themes By Us
| [![Mega-Bundle-HUGO](https://demo.gethugothemes.com/thumbnails/bundle.png?)](https://gethugothemes.com/bundle/?utm_source=dot_github&utm_medium=referral&utm_campaign=github_theme_readme) | [![Godocs](https://demo.gethugothemes.com/thumbnails/godocs.png)](https://gethugothemes.com/products/godocs/) | [![wishfund](https://demo.gethugothemes.com/thumbnails/academia.png)](https://gethugothemes.com/products/academia/) |
|:---:|:---:|:---:|
| **Get 55+ Premium Hugo Themes Bundle** | **Godocs** | **Academia** |