TrueCloudLab/dot-hugo
7
0
Fork 1
Code Issues Pull requests Releases Activity

modified readme file, theme file and installation page

Browse source
This commit is contained in:
somrat 2019-03-13 11:20:07 +06:00
parent d5cd58e809
commit 657b1c6a74
16 changed files with 319 additions and 327 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

77
README.md
View file

@ -1,12 +1,47 @@
# Dot - Hugo Documentation Theme By gethugothemes.com
<div align="center">
# [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)
<img src="https://user-images.githubusercontent.com/37659754/54081086-cc7ce200-4328-11e9-9f7d-74d9b32fa68c.gif" alt="screenshot" width="100%">
</div>
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
@ -22,32 +57,20 @@ Dot, a responsive and feature reach documentation theme ever build in hugo eco s
- 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/) |

3
assets/css/style.css
View file

@ -288,6 +288,9 @@ pre {
z-index: 1;
}
.top-100{
top: 100px;
}
.hero-section {
padding-bottom: 150px;

3
exampleSite/content/installation/install.en.md
View file

@ -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.

3
exampleSite/content/installation/install.fr.md
View file

@ -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.

23
layouts/_default/baseof.html
View file

@ -1,8 +1,27 @@
<!DOCTYPE html>
<html>
<html lang="{{ with .Site.LanguageCode }}{{ . }}{{ else }}en-US{{ end }}">
{{- partial "head.html" . -}}
<body>
{{- partial "navigation.html" . -}}
{{ if .IsHome }}
{{ "<!-- header -->" | safeHTML }}
<header class="hero-section overlay bg-cover banner" data-background="{{ .Site.Params.banner.image | absURL }}">
<div class="container mb-100">
{{ "<!-- navigation -->" | safeHTML }}
{{ partial "navigation.html" . }}
{{ "<!-- /navigation -->" | safeHTML }}
</div>
{{ partial "banner.html" . }}
</header>
{{ "<!-- /header -->" | safeHTML }}
{{ else }}
{{ "<!-- navigation -->" | safeHTML }}
<header class="shadow-bottom sticky-top bg-white">
<div class="container">
{{ partial "navigation.html" . }}
</div>
</header>
{{ "<!-- /navigation -->" | safeHTML }}
{{ end }}
<div id="content">
{{- block "main" . }}{{- end }}
</div>

33
layouts/_default/list.html
View file

@ -1,23 +1,13 @@
{{ partial "head.html" . }}
{{ define "main" }}
{{ "<!-- navigation -->" | safeHTML }}
<header class="shadow-bottom position-relative">
<div class="container">
{{ partial "navigation.html" . }}
</div>
</header>
{{ "<!-- /navigation -->" | safeHTML }}
<!-- page title -->
<section class="section bg-dark">
{{ "<!-- page title -->" | safeHTML }}
<section class="section bg-dark">
<div class="container">
<div class="row">
<div class="col-lg-8 mx-auto text-center">
{{ with .Site.Params.banner.title }} <h1 class="text-white mb-4">{{ . }}</h1> {{ end }}
{{ with .Site.Params.banner.placeholder }} <input id="search" class="form-control" placeholder="{{ . }}"> {{ end }}
<!-- Javascript -->
{{ "<!-- Javascript -->" | safeHTML }}
<script>
$(function() {
var projects = [
@ -52,11 +42,11 @@
</div>
</div>
</div>
</section>
<!-- /page title -->
</section>
{{ "<!-- /page title -->" | safeHTML }}
<!-- details page -->
<section class="single section bg-gray pb-0">
{{ "<!-- details page -->" | safeHTML }}
<section class="single section bg-gray pb-0">
<div class="container">
<div class="row">
<div class="col-lg-3">
@ -86,8 +76,7 @@
</div>
</div>
</div>
</section>
<!-- /details page -->
</section>
{{ "<!-- /details page -->" | safeHTML }}
{{ partial "footer.html" . }}
{{ end }}

5
layouts/_default/single.html
View file

@ -1,20 +1,19 @@
{{ partial "head.html" . }}
{{ "<!-- navigation -->" | safeHTML }}
<header class="shadow-bottom position-relative">
<header class="shadow-bottom sticky-top bg-white">
<div class="container">
{{ partial "navigation.html" . }}
</div>
</header>
{{ "<!-- /navigation -->" | safeHTML }}
<!-- details page -->
<section class="single pt-5 bg-gray">
<div class="container">
<div class="row">
<div class="col-lg-3">
<div class="p-4 bg-white sticky-top">
<div class="p-4 bg-white sticky-top top-100">
{{$currentNode := .}}
<nav class="sidebar-menu">
<ul class="list-styled">

12
layouts/contact/list.html
View file

@ -1,12 +1,4 @@
{{ partial "head.html" . }}
{{ "<!-- navigation -->" | safeHTML }}
<header class="shadow-bottom position-relative">
<div class="container">
{{ partial "navigation.html" . }}
</div>
</header>
{{ "<!-- /navigation -->" | safeHTML }}
{{ define "main" }}
{{ "<!-- contact -->" | safeHTML }}
<section class="section">
@ -28,4 +20,4 @@
</section>
{{ "<!-- /contact -->" | safeHTML }}
{{ partial "footer.html" . }}
{{ end }}

16
layouts/elements/list.html
View file

@ -1,14 +1,6 @@
{{ partial "head.html" . }}
{{ define "main" }}
{{ "<!-- navigation -->" | safeHTML }}
<header class="shadow-bottom position-relative">
<div class="container">
{{ partial "navigation.html" . }}
</div>
</header>
{{ "<!-- /navigation -->" | safeHTML }}
<section class="elements pt-5 bg-gray">
<section class="elements pt-5 bg-gray">
<div class="container">
<div class="row">
<div class="col-12">
@ -16,6 +8,6 @@
</div>
</div>
</div>
</section>
</section>
{{ partial "footer.html" . }}
{{ end }}

23
layouts/faq/list.html
View file

@ -1,17 +1,8 @@
{{ partial "head.html" . }}
{{ define "main" }}
{{ "<!-- navigation -->" | safeHTML }}
<header class="shadow-bottom position-relative">
<div class="container">
{{ partial "navigation.html" . }}
</div>
</header>
{{ "<!-- /navigation -->" | safeHTML }}
{{ $data := index .Site.Data .Site.Language.Lang }}
{{ "<!-- faq -->" | safeHTML }}
<section class="section">
{{ $data := index .Site.Data .Site.Language.Lang }}
{{ "<!-- faq -->" | safeHTML }}
<section class="section">
<div class="container">
<div class="row">
<div class="col-12">
@ -35,7 +26,7 @@
</div>
</div>
</div>
</section>
{{ "<!-- /faq -->" | safeHTML }}
</section>
{{ "<!-- /faq -->" | safeHTML }}
{{ partial "footer.html" . }}
{{ end }}

79
layouts/index.html
View file

@ -1,62 +1,7 @@
{{ partial "head.html" . }}
{{ define "main" }}
{{ "<!-- header -->" | safeHTML }}
<header class="hero-section overlay bg-cover banner" data-background="{{ .Site.Params.banner.image | absURL }}">
<div class="container mb-100">
{{ "<!-- navigation -->" | safeHTML }}
{{ partial "navigation.html" . }}
{{ "<!-- /navigation -->" | safeHTML }}
</div>
{{ "<!-- banner -->" | safeHTML }}
<div class="container">
<div class="row">
<div class="col-lg-8 text-center mx-auto">
{{ with .Site.Params.banner.title }} <h1 class="text-white mb-3">{{ . }}</h1> {{ end }}
{{ with .Site.Params.banner.description }} <p class="text-white mb-4">{{ . }}</p> {{ end }}
<div class="position-relative">
{{ with .Site.Params.banner.placeholder }} <input id="search" class="form-control" placeholder="{{ . }}"> {{ end }}
<!-- Javascript -->
<script>
$(function() {
var projects = [
{{ range .Data.Pages }}
{
value: "{{ .Title }}",
label: "{{ .Title }}",
url:"{{ .Permalink }}"
},
{{ end }}
];
$( "#search" ).autocomplete({
minLength: 0,
source: projects,
focus: function( event, ui ) {
$( "#search" ).val( ui.item.label );
return false;
},
select: function( event, ui ) {
$( "#search" ).val( ui.item.label );
$( "#project-id" ).val( ui.item.value );
return false;
}
})
.data( "ui-autocomplete" )._renderItem = function( ul, item ) {
return $( "<li>" )
.append( "<a href=" + item.url + " + \" &quot;\" + >" + item.label + "</a>" )
.appendTo( ul );
};
});
</script>
</div>
</div>
</div>
</div>
{{ "<!-- /banner -->" | safeHTML }}
</header>
{{ "<!-- /header -->" | safeHTML }}
{{ "<!-- topics -->" | safeHTML }}
<section class="section bg-gray">
{{ "<!-- topics -->" | safeHTML }}
<section class="section bg-gray">
<div class="container">
<div class="row justify-content-center">
<div class="col-12 text-center">
@ -74,12 +19,12 @@
{{ end }}
</div>
</div>
</section>
{{ "<!-- /topics -->" | safeHTML }}
</section>
{{ "<!-- /topics -->" | safeHTML }}
{{ if .Site.Params.cta.enable }}
{{ "<!-- call to action -->" | safeHTML }}
<section class="bg-gray">
{{ if .Site.Params.cta.enable }}
{{ "<!-- call to action -->" | safeHTML }}
<section class="bg-gray">
<div class="container">
<div class="row">
<div class="col-12">
@ -91,8 +36,8 @@
</div>
</div>
</div>
</section>
{{ "<!-- /call to action -->" | safeHTML }}
{{ end }}
</section>
{{ "<!-- /call to action -->" | safeHTML }}
{{ end }}
{{ partial "footer.html" . }}
{{ end }}

45
layouts/partials/banner.html Normal file
View file

@ -0,0 +1,45 @@
{{ "<!-- banner -->" | safeHTML }}
<div class="container">
<div class="row">
<div class="col-lg-8 text-center mx-auto">
{{ with .Site.Params.banner.title }} <h1 class="text-white mb-3">{{ . }}</h1> {{ end }}
{{ with .Site.Params.banner.description }} <p class="text-white mb-4">{{ . }}</p> {{ end }}
<div class="position-relative">
{{ with .Site.Params.banner.placeholder }} <input id="search" class="form-control" placeholder="{{ . }}"> {{ end }}
<!-- Javascript -->
<script>
$(function() {
var projects = [
{{ range .Data.Pages }}
{
value: "{{ .Title }}",
label: "{{ .Title }}",
url:"{{ .Permalink }}"
},
{{ end }}
];
$( "#search" ).autocomplete({
minLength: 0,
source: projects,
focus: function( event, ui ) {
$( "#search" ).val( ui.item.label );
return false;
},
select: function( event, ui ) {
$( "#search" ).val( ui.item.label );
$( "#project-id" ).val( ui.item.value );
return false;
}
})
.data( "ui-autocomplete" )._renderItem = function( ul, item ) {
return $( "<li>" )
.append( "<a href=" + item.url + " + \" &quot;\" + >" + item.label + "</a>" )
.appendTo( ul );
};
});
</script>
</div>
</div>
</div>
</div>
{{ "<!-- /banner -->" | safeHTML }}

5
layouts/partials/footer.html
View file

@ -26,8 +26,3 @@
{{ "<!-- Main Script -->" | safeHTML }}
{{ $script := resources.Get "js/script.js" | minify}}
<script src="{{ $script.Permalink }}"></script>
</body>
</html>

7
layouts/partials/head.html
View file

@ -1,6 +1,3 @@
<!DOCTYPE html>
<html lang="{{ with .Site.LanguageCode }}{{ . }}{{ else }}en-US{{ end }}">
<head>
<meta charset="utf-8">
<title>{{ .Title }}</title>
@ -21,7 +18,6 @@
{{ "<!-- fonts -->" | safeHTML }}
<link href="https://fonts.googleapis.com/css?family=Lato:300,400,700" rel="stylesheet">
<style>
:root{
--primary-color:{{ .Site.Params.primaryColor }};
@ -32,7 +28,6 @@
}
</style>
{{ "<!-- Main Stylesheet -->" | safeHTML }}
{{ $styles := resources.Get "css/style.css" | minify}}
<link rel="stylesheet" href="{{ $styles.Permalink }}" integrity="{{ $styles.Data.Integrity }}" media="screen">
@ -47,5 +42,3 @@
<link rel="icon" href="{{ .Site.BaseURL }}images/favicon.png" type="image/x-icon">
</head>
<body>

2
layouts/partials/navigation.html
View file

@ -37,4 +37,4 @@
{{ end }}
</ul>
</div>
</nav>
</nav>

2
theme.toml
View file

@ -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"