diff --git a/README.md b/README.md index e417f75..812392d 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,47 @@ -# Dot - Hugo Documentation Theme By gethugothemes.com +
+ +# [Dot Hugo](https://gethugothemes.com/) + +[![GitHub stars](https://img.shields.io/github/stars/themefisher/dot-hugo-documentation-theme.svg)](https://github.com/themefisher/dot-hugo-documentation-theme/stargazers) +[![GitHub issues](https://img.shields.io/github/issues/themefisher/dot-hugo-documentation-theme.svg)](https://github.com/themefisher/dot-hugo-documentation-theme/issues) +[![GitHub issues closed](https://img.shields.io/github/issues-closed-raw/themefisher/dot-hugo-documentation-theme.svg?maxAge=2592000)]() +[![GitHub forks](https://img.shields.io/github/forks/themefisher/dot-hugo-documentation-theme.svg)](https://github.com/themefisher/dot-hugo-documentation-theme/network) + +screenshot + +
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. -[Demo](http://demo.gethugothemes.com/dot/) +## Table of Contents -## Screenshots +- [Demo](#demo) +- [Installation](#installation) +- [Main Features](#main-features) +- [Reporting Issues](#reporting-issues) +- [Technical Support or Questions](#technical-support-or-questions) +- [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) | + +[Live Demo](http://demo.gethugothemes.com/dot/). + +## Installation + +Navigate to your themes folder in your Hugo site and use the following commands: + +``` +$ mkdir themes +$ cd themes +$ git clone git@github.com:themefisher/navigator-hugo.git +``` + +[Full Documentation](http://demo.gethugothemes.com/dot/installation/requirments/). -![dot-showcase](https://raw.githubusercontent.com/Gethugothemes/dot-hugo-documentation-theme/master/images/screenshot.png) ## Main features @@ -18,36 +53,24 @@ Dot, a responsive and feature reach documentation theme ever build in hugo eco s - Google Analytics - Color Scheme - Next/Prev buttons in single post page -- Contact Page , Faq Page +- Contact Page , Faq Page - Buttons, Tip/Note/Info/Warning boxes, Expand - Responsive Ready -## Installation +## Reporting Issues -Navigate to your themes folder in your Hugo site and use the following commands: +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) -``` -$ mkdir themes -$ cd themes -$ git clone https://github.com/Gethugothemes/dot-hugo-documentation-theme.git +## Technical Support or Questions -``` -Check that your Hugo version is minimum `0.25` with `hugo version`. +If you have questions or need help integrating the product please [contact us](mailto:themefisher@gmail.com) instead of opening an issue. -For more information read the official [Hugo Documentation](//gohugo.io/overview/installing/). +## Hire Us +We are available for Hiring of your next HUGO project. Drop Us a mail [themefisher@gmail.com](mailto:themefisher@gmail.com) +## Premium Themes -**Important:** Take a look inside the [`exampleSite`](https://github.com/Gethugothemes/dot-hugo-documentation-theme/tree/master/exampleSite) folder of this theme. You'll find a file called `config.toml`. **To use it, copy the `config.toml` in the root folder of your Hugo site.** Feel free to change it. - -Hugo includes a development server, so you can view your changes as you go : - -``` sh -hugo server -w -``` - -Now you can go to [localhost:1313](http://localhost:1313) and the `Dot` -theme should be visible. - -## Customizing -It is a best practice to override a file rather than modify it. This helps you easily update Hugo and the theme without loosing your customizations. To learn more see the Hugo documentation on [customizing Hugo themes](https://gohugo.io/themes/customizing) - +| Biztrox | Bexer | Small Apps | Dtox | +|---|---|---|---| +| [![Biztrox](https://user-images.githubusercontent.com/37659754/54068875-6ab26e80-427b-11e9-876e-4670bdacb975.png)](https://themefisher.com/products/biztrox-hugo-template/) | [![Bexer](https://user-images.githubusercontent.com/37659754/54068892-84ec4c80-427b-11e9-9952-5d455c259145.png)](https://themefisher.com/products/bexer-hugo-theme/) | [![Small Apps](https://user-images.githubusercontent.com/37659754/54068897-96cdef80-427b-11e9-8fd4-2a5b83cea6d0.png)](https://themefisher.com/products/small-apps-hugo-app-landing-theme/) | [![Dtox](https://user-images.githubusercontent.com/37659754/54068836-07284100-427b-11e9-8ff2-48eec3220a26.png)](https://themefisher.com/products/dtox-hugo-theme/) | \ No newline at end of file diff --git a/assets/css/style.css b/assets/css/style.css index 29e6c2a..109b607 100644 --- a/assets/css/style.css +++ b/assets/css/style.css @@ -288,6 +288,9 @@ pre { z-index: 1; } +.top-100{ + top: 100px; +} .hero-section { padding-bottom: 150px; diff --git a/exampleSite/content/installation/install.en.md b/exampleSite/content/installation/install.en.md index 92c5914..1fd8221 100644 --- a/exampleSite/content/installation/install.en.md +++ b/exampleSite/content/installation/install.en.md @@ -23,6 +23,9 @@ This theme's repository is: https://github.com/matcornic/Doc-List.git Alternatively, you can [download the theme as .zip](https://github.com/matcornic/Doc-List/archive/master.zip) file and extract it in the `themes` directory +Or you can check this video documentation for installing this template: +{{< youtube Srt3lTmRxzQ >}} + ### Basic configuration When building the website, you can set a theme by using `--theme` option. However, we suggest you modify the configuration file (`config.toml`) and set the theme as the default. diff --git a/exampleSite/content/installation/install.fr.md b/exampleSite/content/installation/install.fr.md index 92c5914..1fd8221 100644 --- a/exampleSite/content/installation/install.fr.md +++ b/exampleSite/content/installation/install.fr.md @@ -23,6 +23,9 @@ This theme's repository is: https://github.com/matcornic/Doc-List.git Alternatively, you can [download the theme as .zip](https://github.com/matcornic/Doc-List/archive/master.zip) file and extract it in the `themes` directory +Or you can check this video documentation for installing this template: +{{< youtube Srt3lTmRxzQ >}} + ### Basic configuration When building the website, you can set a theme by using `--theme` option. However, we suggest you modify the configuration file (`config.toml`) and set the theme as the default. diff --git a/layouts/_default/baseof.html b/layouts/_default/baseof.html index 3bd9770..260153c 100644 --- a/layouts/_default/baseof.html +++ b/layouts/_default/baseof.html @@ -1,11 +1,30 @@ - + {{- partial "head.html" . -}} - {{- partial "navigation.html" . -}} + {{ if .IsHome }} + {{ "" | safeHTML }} + + {{ "" | safeHTML }} + {{ else }} + {{ "" | safeHTML }} +
+
+ {{ partial "navigation.html" . }} +
+
+ {{ "" | safeHTML }} + {{ end }}
{{- block "main" . }}{{- end }}
{{- partial "footer.html" . -}} - + \ No newline at end of file diff --git a/layouts/_default/list.html b/layouts/_default/list.html index 13706be..805d28a 100644 --- a/layouts/_default/list.html +++ b/layouts/_default/list.html @@ -1,93 +1,82 @@ -{{ partial "head.html" . }} +{{ define "main" }} - -{{ "" | safeHTML }} -
-
- {{ partial "navigation.html" . }} -
-
-{{ "" | safeHTML }} - - - -
-
-
-
- {{ with .Site.Params.banner.title }}

{{ . }}

{{ end }} - {{ with .Site.Params.banner.placeholder }} {{ end }} - - -
-
-
-
- - - -
-
-
-
-
- -

{{ .Title }}

-
- -
-
-
-
-

{{ .Title }}

-
-

Article

-
    + {{ "" | safeHTML }} +
    +
    +
    +
    + {{ with .Site.Params.banner.title }}

    {{ . }}

    {{ end }} + {{ with .Site.Params.banner.placeholder }} {{ end }} + {{ "" | safeHTML }} +
    -
-
- + + {{ "" | safeHTML }} + {{ "" | safeHTML }} +
+
+
+
+
+ +

{{ .Title }}

+
+ +
+
+
+
+

{{ .Title }}

+
+

Article

+ +
+
+
+
+
+
+ {{ "" | safeHTML }} -{{ partial "footer.html" . }} \ No newline at end of file +{{ end }} \ No newline at end of file diff --git a/layouts/_default/single.html b/layouts/_default/single.html index 4c3f9fc..db2d5f0 100644 --- a/layouts/_default/single.html +++ b/layouts/_default/single.html @@ -1,20 +1,19 @@ {{ partial "head.html" . }} {{ "" | safeHTML }} -
+
{{ partial "navigation.html" . }}
{{ "" | safeHTML }} -
-
+
{{$currentNode := .}} - + {{define "menu"}} {{- $currentNode := .currentnode -}} {{ with .sect }} diff --git a/layouts/contact/list.html b/layouts/contact/list.html index 06be048..b67e5d5 100644 --- a/layouts/contact/list.html +++ b/layouts/contact/list.html @@ -1,12 +1,4 @@ -{{ partial "head.html" . }} - -{{ "" | safeHTML }} -
-
- {{ partial "navigation.html" . }} -
-
-{{ "" | safeHTML }} +{{ define "main" }} {{ "" | safeHTML }}
@@ -28,4 +20,4 @@
{{ "" | safeHTML }} -{{ partial "footer.html" . }} \ No newline at end of file +{{ end }} \ No newline at end of file diff --git a/layouts/elements/list.html b/layouts/elements/list.html index 418cbc5..8a75f98 100644 --- a/layouts/elements/list.html +++ b/layouts/elements/list.html @@ -1,21 +1,13 @@ -{{ partial "head.html" . }} +{{ define "main" }} -{{ "" | safeHTML }} -
-
- {{ partial "navigation.html" . }} -
-
-{{ "" | safeHTML }} - -
-
-
-
- {{ .Content }} +
+
+
+
+ {{ .Content }} +
-
-
+
-{{ partial "footer.html" . }} \ No newline at end of file +{{ end }} \ No newline at end of file diff --git a/layouts/faq/list.html b/layouts/faq/list.html index 3c8d44c..a2dd44e 100644 --- a/layouts/faq/list.html +++ b/layouts/faq/list.html @@ -1,41 +1,32 @@ -{{ partial "head.html" . }} +{{ define "main" }} -{{ "" | safeHTML }} -
-
- {{ partial "navigation.html" . }} -
-
-{{ "" | safeHTML }} - -{{ $data := index .Site.Data .Site.Language.Lang }} - -{{ "" | safeHTML }} -
-
-
-
-

{{ .Params.Title }}

- {{ "" | safeHTML }} -
- {{ range $data.faq.faqItem }} - {{ "" | safeHTML }} -
- -
-
{{ .content }}
+ {{ $data := index .Site.Data .Site.Language.Lang }} + {{ "" | safeHTML }} +
+
+
+
+

{{ .Params.Title }}

+ {{ "" | safeHTML }} +
+ {{ range $data.faq.faqItem }} + {{ "" | safeHTML }} +
+ +
+
{{ .content }}
+
+ {{ end }}
- {{ end }}
-
-
-{{ "" | safeHTML }} + + {{ "" | safeHTML }} -{{ partial "footer.html" . }} \ No newline at end of file +{{ end }} \ No newline at end of file diff --git a/layouts/index.html b/layouts/index.html index 433ae79..959f4aa 100644 --- a/layouts/index.html +++ b/layouts/index.html @@ -1,98 +1,43 @@ -{{ partial "head.html" . }} +{{ define "main" }} -{{ "" | safeHTML }} - -{{ "" | safeHTML }} + + {{ "" | safeHTML }} + {{ end }} -{{ "" | safeHTML }} -
-
-
-
- {{with .Site.Params.topics.title}}

{{ . }}

{{ end }} -
- {{ "" | safeHTML }} - {{ range (where .Site.Pages "Type" "pages") }} - - {{ end }} -
-
-
-{{ "" | safeHTML }} - -{{ if .Site.Params.cta.enable }} -{{ "" | safeHTML }} -
-
-
-
-
- {{ with .Site.Params.cta.title }}

{{ . }}

{{ end }} - {{ with .Site.Params.cta.description }}

{{ . }}

{{ end }} - {{ with .Site.Params.cta.btnText}}{{ . }}{{ end }} -
-
-
-
-
-{{ "" | safeHTML }} -{{ end }} - -{{ partial "footer.html" . }} \ No newline at end of file +{{ end }} \ No newline at end of file diff --git a/layouts/partials/banner.html b/layouts/partials/banner.html new file mode 100644 index 0000000..0071c0e --- /dev/null +++ b/layouts/partials/banner.html @@ -0,0 +1,45 @@ +{{ "" | safeHTML }} +
+
+
+ {{ with .Site.Params.banner.title }}

{{ . }}

{{ end }} + {{ with .Site.Params.banner.description }}

{{ . }}

{{ end }} +
+ {{ with .Site.Params.banner.placeholder }} {{ end }} + + +
+
+
+
+{{ "" | safeHTML }} \ No newline at end of file diff --git a/layouts/partials/footer.html b/layouts/partials/footer.html index e5d26c2..116a15a 100644 --- a/layouts/partials/footer.html +++ b/layouts/partials/footer.html @@ -25,9 +25,4 @@ {{ "" | safeHTML }} {{ $script := resources.Get "js/script.js" | minify}} - - - - - - \ No newline at end of file + \ No newline at end of file diff --git a/layouts/partials/head.html b/layouts/partials/head.html index df19706..e550316 100644 --- a/layouts/partials/head.html +++ b/layouts/partials/head.html @@ -1,6 +1,3 @@ - - - {{ .Title }} @@ -21,7 +18,6 @@ {{ "" | safeHTML }} - - {{ "" | safeHTML }} {{ $styles := resources.Get "css/style.css" | minify}} @@ -46,6 +41,4 @@ {{ "" | safeHTML }} - - - \ No newline at end of file + \ No newline at end of file diff --git a/layouts/partials/navigation.html b/layouts/partials/navigation.html index a264893..203cd5f 100644 --- a/layouts/partials/navigation.html +++ b/layouts/partials/navigation.html @@ -1,40 +1,40 @@ \ No newline at end of file + + \ No newline at end of file diff --git a/theme.toml b/theme.toml index 55383b8..f85eb17 100644 --- a/theme.toml +++ b/theme.toml @@ -5,7 +5,7 @@ name = "Dot" license = "Creative Commons — Attribution 3.0 Unported — CC BY 3.0" licenselink = "https://creativecommons.org/licenses/by/3.0/" description = "Dot, A documentation theme powered by hugo" -homepage = "https://themefisher.com/hugo-themes" +homepage = "https://gethugothemes.com/" tags = ["documentation", "bootstrap", "blog", "contact","responsive", "gethugothemes", "Syntax highlighting " , "Multilingual" , "Single page", "Themefisher"] features = [] min_version = "0.54"