dot-hugo/README.md

89 lines
5.8 KiB
Markdown
Raw Normal View History

<div align="center">
2019-12-21 07:57:59 +00:00
<h1><a href="https://gethugothemes.com/products/hugo-documentation-theme/">Dot Hugo Documentation Theme [Version : 2.0]</a></h1>
<p><a href="https://github.com/themefisher/dot-hugo-documentation-theme/stargazers"><img src="https://camo.githubusercontent.com/7d6b302902df5eaa1a880850777f6cbc089abc5b/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f73746172732f7468656d656669736865722f646f742d6875676f2d646f63756d656e746174696f6e2d7468656d652e737667" alt="GitHub stars" data-canonical-src="https://img.shields.io/github/stars/themefisher/dot-hugo-documentation-theme.svg" style="max-width:100%;"></a>
<a href="https://github.com/themefisher/dot-hugo-documentation-theme/issues"><img src="https://camo.githubusercontent.com/82ea79e787e3159369049285257d62b85e2c0d35/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6973737565732f7468656d656669736865722f646f742d6875676f2d646f63756d656e746174696f6e2d7468656d652e737667" alt="GitHub issues" data-canonical-src="https://img.shields.io/github/issues/themefisher/dot-hugo-documentation-theme.svg" style="max-width:100%;"></a>
<a href="/themefisher/dot-hugo-documentation-theme/blob/master"><img src="https://camo.githubusercontent.com/5cb0da6a96f0f7b4861202b46486e3b36f813831/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6973737565732d636c6f7365642d7261772f7468656d656669736865722f646f742d6875676f2d646f63756d656e746174696f6e2d7468656d652e7376673f6d61784167653d32353932303030" alt="GitHub issues closed" data-canonical-src="https://img.shields.io/github/issues-closed-raw/themefisher/dot-hugo-documentation-theme.svg?maxAge=2592000" style="max-width:100%;"></a>
<a href="https://github.com/themefisher/dot-hugo-documentation-theme/network"><img src="https://camo.githubusercontent.com/a740e4878301293eb179787617f3335fe6b7dbe6/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f666f726b732f7468656d656669736865722f646f742d6875676f2d646f63756d656e746174696f6e2d7468656d652e737667" alt="GitHub forks" data-canonical-src="https://img.shields.io/github/forks/themefisher/dot-hugo-documentation-theme.svg" style="max-width:100%;"></a></p>
<img src="https://user-images.githubusercontent.com/37659754/54081086-cc7ce200-4328-11e9-9f7d-74d9b32fa68c.gif" alt="screenshot" width="100%">
</div>
2019-01-06 18:14:06 +00:00
Dot, a responsive and feature reach documentation theme ever build in hugo eco system . We have analysised a lot of documentation and knowledge base theme to come up with this design . The readability and the cleaness is also another key feature of this theme.
2019-12-21 07:57:59 +00:00
2019-01-06 18:14:06 +00:00
2019-11-18 06:32:43 +00:00
### What's New in version 2.0
This template is now in a new layout. You can create page with folder, and also gives required images in this folder. Multilangual is now more fun. No more bugs and issues. It's all like a new experience. Configuration of this theme is now more easier.
**Version 2.0 comes with MIT Licence**
## Table of Contents
2019-01-06 18:14:06 +00:00
- [Demo](#demo)
- [Installation](#installation)
- [Main Features](#main-features)
- [Reporting Issues](#reporting-issues)
2020-07-05 05:27:38 +00:00
- [Technical Support or Questions](#technical-support-or-questions-(paid))
- [More Hugo Themes](https://themefisher.com/hugo-themes/)
## Demo
| Elements | FAQ | Inner Page | Contact |
|---|---|---|---|
| ![Elements page](https://user-images.githubusercontent.com/37659754/54081094-e1f20c00-4328-11e9-90e8-eeda5e3cb427.png) | ![FAQ page](https://user-images.githubusercontent.com/37659754/54081095-e1f20c00-4328-11e9-8009-24987d98e2d0.png) | ![Inner page](https://user-images.githubusercontent.com/37659754/54081096-e28aa280-4328-11e9-97d2-6eb94da191ca.png) | ![Contact page](https://user-images.githubusercontent.com/37659754/54081093-e1597580-4328-11e9-981b-859b1a7e94d9.png) |
2019-12-21 07:57:59 +00:00
**The images are only for demonstration purpose, Please don't use those images.**
2019-11-10 05:19:17 +00:00
[Live Demo](http://demo.themefisher.com/dot-hugo/).
## Installation
Navigate to your themes folder in your Hugo site and use the following commands:
```
$ mkdir themes
$ cd themes
2019-05-01 14:52:27 +00:00
$ git clone git@github.com:themefisher/dot-hugo-documentation-theme.git
```
2020-12-29 07:16:12 +00:00
Or Check out [Full Documentation](https://docs.gethugothemes.com/dot/?ref=github).
2019-01-06 18:14:06 +00:00
## Main features
- Automatic Search
- Search Suggestion
- Syntax highlighting
- Multilingual mode
- Bootstrap 4 Powered
- Google Analytics
- Color Scheme
- Next/Prev buttons in single post page
- Contact Page , Faq Page
2019-01-06 18:14:06 +00:00
- Buttons, Tip/Note/Info/Warning boxes, Expand
- Responsive Ready
2020-09-21 12:53:07 +00:00
## Reporting Issues or Contributing
We use GitHub Issues as the official bug tracker for the Navigator Template. Please Search [existing issues](https://github.com/themefisher/dot-hugo-documentation-theme/issues). It’s possible someone has already reported the same problem.
If your problem or idea is not addressed yet, [open a new issue](https://github.com/themefisher/dot-hugo-documentation-theme/issues)
2019-01-06 18:14:06 +00:00
2020-09-21 12:53:07 +00:00
Contributions are welcome and we will review and consider pull requests.
Primary goals are:
- Keep it simple.
- Keep minimal (or zero) default configuration.
- Avoid interference with user-defined layouts.
- Avoid using JS if it can be solved by CSS.
2020-07-05 05:27:38 +00:00
## Technical Support or Questions (Paid)
2019-01-06 18:14:06 +00:00
2020-09-20 02:59:05 +00:00
If you have questions or need help integrating the product please [contact us](mailto:mehedi@themefisher.com) instead of opening an issue.
## Hire Us
2020-09-06 09:09:00 +00:00
We are available for Hiring of your next HUGO project. Drop Us a mail [mehedi@themefisher.com](mailto:mehedi@themefisher.com)
2019-01-06 18:14:06 +00:00
2020-09-21 12:53:07 +00:00
## Premium Themes
2019-01-06 18:14:06 +00:00
2020-02-29 04:19:24 +00:00
| [![Mega-Bundle-HUGO](https://gethugothemes.com/wp-content/uploads/edd/2019/09/Mega-Bundle-HUGO.png)](https://themefisher.com/products/hugo-mega-bundle/) | [![GoDocs](https://gethugothemes.com/wp-content/uploads/edd/2020/02/Home-Page-2.png)](https://gethugothemes.com/products/godocs-hugo-documentation-theme/) | [![Academia](https://gethugothemes.com/wp-content/uploads/edd/2019/08/Academia.jpg)](https://gethugothemes.com/products/academia/) |
2019-05-16 04:40:34 +00:00
|:---:|:---:|:---:|
2020-12-29 07:16:12 +00:00
| **Hugo Mega Bundle** | **GoDocs** | **Academia** |