Git Product home page Git Product logo

themefisher / dot-hugo Goto Github PK

View Code? Open in Web Editor NEW
254.0 8.0 148.0 6.1 MB

Dot - Hugo Documentation Theme

Home Page: https://gethugothemes.com/products/dot/?utm_source=dot_github&utm_medium=referral&utm_campaign=github_theme_about

License: MIT License

JavaScript 36.64% HTML 30.86% SCSS 30.78% Shell 1.72%
hugo-documentation hugo-site documentation responsive search-suggestions faqs light-theme hugo-theme hugo hugo-docs-theme documentation-website documentation-theme gethugothemes static-site-generator mit-license jamstack

dot-hugo's Introduction

Dot Hugo

Dot is a simple Hugo documentation theme with a professional outlook.

license code size contributors follow on Twitter


screenshot


🔑Key Features

  • 📄 8+ Pre-designed pages
  • 🈳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

📄 8+ Pre-Designed Pages

  • 🏠Home
  • 👤About
  • 📞Contact
  • ❔Faq Page
  • 🌟Features Page
  • 🔧Installation Page
  • 💰Pricing Page
  • ❔404 Page

🛠️Local development

# clone the repository
git clone [email protected]:themefisher/dot-hugo.git

# setup project
$ yarn project-setup

# Start local dev server
$ yarn dev

Or Check out Full Documentation.

🔧Deployment and hosting

Deploy to Netlify

Follow the steps.

🐞Reporting Issues

We use GitHub Issues as the official bug tracker for the dot Template. Please Search existing 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.

📱Submit Your Website To Our Showcase

Are you using Dot Hugo theme? Submit it to our 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.

Submit your Dot Hugo powered website.

📝License

Copyright © Designed by Themefisher & Developed by Gethugothemes

Code License: Released under the MIT license.

Image license: The images are only for demonstration purposes. They have their licenses. We don't have permission to share those images.

👍Special Thanks

👨‍💻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

💎Premium Themes By Us

Mega-Bundle-HUGO Godocs wishfund
Get 55+ Premium Hugo Themes Bundle Godocs Academia

dot-hugo's People

Contributors

aborruso avatar ashwin153 avatar caseydierking avatar chanix95 avatar davidsneighbour avatar faarhadhossen avatar idadelveloper avatar jcabak avatar jwflory avatar life1347 avatar longlivechief avatar mehedi-sharif avatar niwo avatar ohanedan avatar seiyria avatar shampaakter avatar somratpro avatar ssojonn avatar tffarhad avatar tflijon avatar tfsojon avatar tfsomrat avatar tfsumon avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

dot-hugo's Issues

Cannot find map files

I installed this with new Hugo installation But it's unable to render itself, as it's looking for map files and was unable to find.

Hugo version Hugo Static Site Generator v0.69.0/extended darwin/amd64.

[Error] Failed to load resource: the server responded with a status of 404 (Not Found) (bootstrap.min.css.map, line 0)
[Error] Failed to load resource: the server responded with a status of 400 () (css, line 0)
[Error] Failed to load resource: the server responded with a status of 404 (Not Found) (bootstrap.min.js.map, line 0)

Add a logo

Hi,

Thanks for this theme.

I would like to add a logo in white on the homepage and in black on the other pages.

I tried to add this on config.toml : logo = "images/logo.png" but it did'nt work.

Best regards.

Initial installation not working.

Following basic instructions to setup this theme does not bode well.

When running hugo serve this is the error. Unsure if this is on my end or this themes end of things.

ERROR 2019/04/12 14:49:49 Failed to add template "partials/footer.html" in path "partials\\footer.html": template: partials/footer.html:27: function "resources" not defined ERROR 2019/04/12 14:49:49 Failed to add template "partials/head.html" in path "partials\\head.html": template: partials/head.html:32: function "resources" not defined ERROR 2019/04/12 14:49:49 partials/footer.html : template: partials/footer.html:27: function "resources" not defined ERROR 2019/04/12 14:49:49 partials/head.html : template: partials/head.html:32: function "resources" not defined ERROR 2019/04/12 14:49:49 Current theme does not support Hugo version 0.42.1. Minimum version required is 0.54 Building sites … ERROR 2019/04/12 14:49:49 Error while rendering "taxonomyTerm" in "": template: _default\list.html:3:8: executing "_default\\list.html" at <partial "head.html" ...>: error calling partial: template: "partials/head.html" is an incomplete or empty template ERROR 2019/04/12 14:49:49 Error while rendering "home" in "": template: index.html:3:8: executing "index.html" at <partial "head.html" ...>: error calling partial: template: "partials/head.html" is an incomplete or empty template ERROR 2019/04/12 14:49:50 Error while rendering "page" in "": template: _default\single.html:1:3: executing "_default\\single.html" at <partial "head.html" ...>: error calling partial: Partial "head.html" not found ERROR 2019/04/12 14:49:50 Error while rendering "home" in "": template: index.html:3:8: executing "index.html" at <partial "head.html" ...>: error calling partial: Partial "head.html" not found ERROR 2019/04/12 14:49:50 Error while rendering "taxonomyTerm" in "": template: _default\list.html:3:8: executing "_default\\list.html" at <partial "head.html" ...>: error calling partial: Partial "head.html" not found Total in 73 ms Error: Error building site: logged 10 error(s)

Render of section failed

I wanted to run a new hugo instance and got this when doing hugo server -D:

Building sites … ERROR 2019/04/19 15:08:47 render of "section" failed: execute of template failed: template: _default/list.html:29:59: executing "main" at <.Site.Params.dateformat>: invalid value; expected string
Total in 17 ms
Error: Error building site: failed to render pages: render of "page" failed: execute of template failed: template: _default/single.html:17:55: executing "main" at <.Site.Params.dateformat>: invalid value; expected string

Hugo version is 0.55.2.

Deprecated features reported in Hugo 0.60.1

I'm using the DOT theme for building a small static site, but when running v0.60.1 I get several warnings:

WARN 2019/12/15 12:08:47 Page.URL is deprecated and will be removed in a future release. Use .Permalink or .RelPermalink. If what you want is the front matter URL value, use .Params.url
WARN 2019/12/15 12:08:47 Page.UniqueID is deprecated and will be removed in a future release. Use .File.UniqueID
WARN 2019/12/15 12:08:47 .File.UniqueID on zero object. Wrap it in if or with: {{ with .File }}{{ .UniqueID }}{{ end }}
WARN 2019/12/15 12:08:47 .File.Path on zero object. Wrap it in if or with: {{ with .File }}{{ .Path }}{{ end }}

Any idea on how to fix these?

Search through page content

The search only uses the title for searching or at least so it seems.
Is there a way to search through the entire page and provide hidden synonyms to search for?

Broken "Home" link when not using multiple languages (regression)

This issue is a regression from issue #120. With all the changes done in the structure, again:
When using the dot theme with only only language, the "Home" links are broken.

You can simply use former merge request and change the file layouts/partials/navigation.html and put in the Link to home. Since I need some text I use the .Site.Params.Hometext variable which I created in config.toml and which especially is a "works for me" solution.

I hope the following diff helps, I unfortuentaly didn't check everything and therefore didn't create a merge request.

$ git diff
diff --git a/config.toml b/config.toml
index 7b2ce42..f026e65 100644
--- a/config.toml
+++ b/config.toml
@@ -10,6 +10,7 @@ logo = "images/logo.png"
 # logo white is for homepage logo, you can use colorful logo too...
 logo_white = ""
 # when logo is empty, it will shown your site title
+hometext = "home"

 # customize color
 primary_color = "#E20074"
diff --git a/themes/dot/layouts/partials/navigation.html b/themes/dot/layouts/partials/navigation.html
index e6c5a8f..bcbc64b 100644
--- a/themes/dot/layouts/partials/navigation.html
+++ b/themes/dot/layouts/partials/navigation.html
@@ -21,6 +21,9 @@

     <div class="collapse navbar-collapse text-center" id="navigation">
       <ul class="navbar-nav ml-auto">
+        <li class="nav-item">
+          <a class="nav-link text-light" href="{{ .Site.BaseURL | relLangURL }}">{{ .Site.Params.Hometext }}</a>
+        </li>
         {{ range site.Menus.main }}
         {{ if .HasChildren }}
         <li class="nav-item dropdown">

Live reload not working on article

Hello, we found an issue with the live reload of articles.

Editing an article do not reload the site.

PS: we found a way to fix it by adding '<body>' tags in the single.html page in the _default layout

ToC management

It would be perfect to have the ability to enable Table of Contents for pages and posts.
Maybe on a column at the right of the content column.

Blank install

Screenshot (18)

When I type in hugo server on a fresh install this is what I see.

Steps to reproduce the issue:

  1. Type in command line Hugo new site dot-theme
  2. Opened dot-theme directory
  3. Open theme folder which was empty
  4. Download the zip file by using the following link https://github.com/themefisher/dot-hugo-documentation-theme/archive/master.zip
  5. Unzipped file and renamed it dot.
  6. Move dot folder into my theme folder.
  7. Added the line theme = "dot" to the config.toml
  8. Typed in the command line hugo server
  9. Opened the browser and took the screenshot above.

Can you let me know what I am doing wrong?

Hugo Static Site Generator v0.68.3-157669A0 windows/amd64 BuildDate: 2020-03-24T12:04:36Z

Extra space added after line using icon within paragraph

Here's an odd thing that happens when I use a fontawesome icon :

Screen Shot 2021-01-20 at 14 56 04

I don't see any line break in the source code though :

<h5 id="paragraph">Paragraph</h5>
<p>Lorem ipsum dolor sit amet consectetur <a href="https://github.com/themefisher/dot-hugo-documentation-theme" target="_blank"><i class="fas fa-external-link-square-alt"></i></a> adipisicing elit. Quam nihil enim maxime corporis cumque totam aliquid nam sint inventore optio modi neque laborum officiis necessitatibus, facilis placeat pariatur! Voluptatem, sed harum pariatur adipisci voluptates voluptatum cumque, porro sint minima similique magni perferendis fuga! Optio vel ipsum excepturi tempore reiciendis id quidem? Vel in, doloribus debitis nesciunt fugit sequi magnam accusantium modi neque quis, vitae velit, pariatur harum autem a! Velit impedit atque maiores animi possimus asperiores natus repellendus excepturi sint architecto eligendi non, omnis nihil. Facilis, doloremque illum. Fugit optio laborum minus debitis natus illo perspiciatis corporis voluptatum rerum laboriosam.</p>

Here's how to reproduce the issue :

  1. Use the exampleSite from the repo.
  2. Add the fontawesome CDN to layouts/partials/head.html.
  3. Use a fontawesome icon within any paragraph.

Any advice on how to get rid of the extra spacing would be appreciated.

Thanks for the nice theme !

Unmarshal of format "" is not supported

Great theme. However running into an issue. I ran it through it (without data "en" & "fr" data) and loads files fine.

Adding data ("en" and "fr") back in outputs the result below for both fr and en.

Any thoughts? Am on the newest release of Hugo .61.0


28 ERROR 2019/12/17 20:46:53 failed to load data: failed to load data: "/builds/alphabetacreatives/familyreunion/data/en:1:1": unmarshal of format "" is not supported

30 Error: Error building site: failed to load data: failed to load data: "/builds/alphabetacreatives/familyreunion/data/en:1:1": unmarshal of format "" is not supported
34 ERROR: Job failed: exit code 1

Cheers,

Show related articles with shared keywords at the bottom of an article

See unicef/inventory#12 for the original feature request and unicef/inventory#25 for an implementation.

This makes it easier to create learning pathways through the knowledgebase, and connect related pages in a category together. @MuluhGodson implemented this already, and I wanted to first check if upstream is willing to carry the patches for CSS/Hugo, or if I should carry the patch in my downstream fork.

Please share thoughts so we can make appropriate next steps, thank you!

Banner Hex Color issues

The Banner on the main page, seems to alter the primary color hex code.

After setting the color in the config, it seems to brighten the color when actually generated.

Is there anyway we can prevent it from brightening the color?

Formspree.io legacy forms is not longer available

Hello,

A few months ago formspree.io discontinued legacy forms and now the template no longer works for new sites(forms). The solution is to change the line below to include a method="POST" to the form action. I have tried to add it via a few iterations below, but none seem to work.

contact_form_action = 'https://formspree.io/f/[email protected]" method="POST'
contact_form_action = "https://formspree.io/f/[email protected]\" method=\"POST\""

Here is the affected line: https://github.com/themefisher/dot-hugo-documentation-theme/blob/f90395f13bdf64555625835a98bd84db3e959578/layouts/contact/list.html#L10

I have tested with the line below in the list.html

line 10: <form action="{{ .Site.Params.contact_form_action | safeURL }}" method="POST">

and the line below in config.toml

contact_form_action = "https://formspree.io/f/[email protected]" # contact form works with : https://formspree.io

Thanks for such a great theme, this is really clean and simple. My wife really likes it, she said 'I wish ALL websites looked like this', and she predominantly uses mobile devices for her browsing and work.

Need documentation

Hi,

I'm currently using Dot theme in hugo project.
And I can't find any documentation to help me implement my website : changing images (banner for example), changing colors, etc...

Thanks

Disable language switcher when there is only one language

Since the language switcher breaks when there is only one language (this is also worth investigating), it would be great if one could disable it.

E.g. by using a similar condition (inspiration):

    <!-- Language List -->
    {{- if and .Site.IsMultiLingual (not .Site.Params.DisableLanguageSwitchingButton)}}
    <select id="select-language" onchange="location = this.value;">
      {{ $siteLanguages := .Site.Languages}}
      {{ $pageLang := .Page.Lang}}
      {{ range .Page.AllTranslations }}
      {{ $translation := .}}
      {{ range $siteLanguages }}
      {{ if eq $translation.Lang .Lang }}
      {{ $selected := false }}
      {{ if eq $pageLang .Lang}}
      <option id="{{ $translation.Language }}" value="{{ $translation.URL }}" selected>{{ .LanguageName }}
      </option>
      {{ else }}
      <option id="{{ $translation.Language }}" value="{{ $translation.URL }}">{{ .LanguageName }}</option>
      {{ end }}
      {{ end }}
      {{ end }}
      {{ end }}
    </select>
    {{ end }}

Thank you for the hard work!

Security vulnerabilities in bundled libraries

Hi,

When running a site using this theme through a Lighthouse audit on the Chrome browser, the audit warns about the following security issues (sorry for the bad contrast in the screenshot).

Security Audit

Could these be updated to newer versions?

FAQ shortcode produces invalid HTML IDs

The FAQ shortcode is great feature, but seems to produce invalid IDs when encountering certain characters. Most notably '.' and '/' characters. This in turn stops the accordion from Bootstrap working properly.

Example markdown:

{{< faq "My computer sometimes / always stops working" >}}
Try turning it off and on again.
{{</ faq >}}

Which in turn produces:

<div class="card mb-4 rounded-0 shadow border-0">
  <div class="card-header rounded-0 bg-white border p-0 border-0">
    <a class="card-link h4 d-flex tex-dark mb-0 py-3 px-4 justify-content-between" data-toggle="collapse" href="#my-computer-sometimes-%2f-always-stops-working">
      <span>My computer sometimes / always stops working</span> <i class="ti-plus text-primary text-right"></i>
    </a>
  </div>
  <div id="my-computer-sometimes-/-always-stops-working" class="collapse" data-parent="#accordion">
    <div class="card-body font-secondary text-color">Try turning it off and on again.</div>
  </div>
</div>

I think the problematic lines are as follows:
https://github.com/themefisher/dot/blob/6f6257751b70c8493d5b815208d38c7802323831/layouts/shortcodes/faq.html#L5
https://github.com/themefisher/dot/blob/6f6257751b70c8493d5b815208d38c7802323831/layouts/shortcodes/faq.html#L9

Replacing urlize with anchorize has fixed it on my local copy. I'm happy to do a pull request with this change in? (Will change how the IDs were being generated, though.)

Unordered and ordered list font-size is bigger than the body text font-size

This should fix the issue:

$ diff -u themes/dot/assets/css/style.css assets/css/style.css
--- themes/dot/assets/css/style.css	2020-07-02 12:23:34.000000000 +0200
+++ assets/css/style.css	2020-07-02 12:37:08.000000000 +0200
@@ -137,9 +137,11 @@
   list-style-type: none;
   margin: 0px;
   padding-left: 0;
+  font-size: 15px;
 }

 ol {
+  font-size: 15px;
   padding-left: 20px;
 }

Build Error with Hugo 0.64.1 ".File.UniqueID on zero object."

Building sites … WARN 2020/02/13 15:46:01 .File.UniqueID on zero object. Wrap it in if or with: {{ with .File }}{{ .UniqueID }}{{ end }}

No idea where this is or how to find it, but using Hugo 0.64.1, I get that build error on the exampleSite using: hugh --themesDir ../.. from the exampleSite folder

The site is available, but not sure where that warn originates from/at.

Unable to use bullet points in content

Looking for the best way to represent markdown bullet points within content pages.

Using the following does not result in bullet points:

List:
- item 1
- item 2
- item 3

Expected:

List:

  • item 1
  • item 2
  • item 3

Notice and Tab didn't work

the shortcode is there,but when i just try to deploy the example site,i still find the Tab and Notice not working
image

H2 being generated instead of H1

The content shows that an H2 is being generated instead of H1. Is this by design and how should I replace it with an H1 instead?

FAQ with formatting

How can the text in the FAQ be formatted?
I would like to use bold or italic and possibly the option to include a short code snippet.

HTML tags don't seem to work, nor does MD formatting.

actionArgumentsにoptionsを追加する

やること

  • type ActionArgumentにoptionsを追加する
  • RadioComponentなどの選択肢選ぶActionsに上記のoptionsを利用する
  • sample jsonも上記型に合わせて修正

Ordering within a section.

There doesn't seem to be a way to order pages within a section. For example in the Billing and Pricing part of the example site, I do not see a way to force an ordering of the pages in the left hand bar.

how to add content on faq section?

I copied content from exampleSite folder. But looks example content for FAQ is missing. Including sample examples in project itself is helpful to start.

Navigation with many subitems is hard to navigate

https://github.com/themefisher/dot-hugo-documentation-theme/blob/995ed2f6873584921378a26f7ffeaf2a6512baae/layouts/partials/default.html#L5

This navigation makes the user scroll to the bottom of the page so he can see items that are out of the view port. I tested it with some of the demo pages and a small browser window. The navigation stays static on the top left, then when I reach the end of the page the nav finally scrolls up too and makes items further down the list available.

see https://discourse.gohugo.io/t/ot-dot-theme-collapsing-sidebar-feature/29382

The way it is done on the Guide page might be better. https://docs.gethugothemes.com/guide/ On that page I can hover with the mouse and scroll the navigation down/up.

Another way would be collapsible from bootstrap for subitems.

Navigation links incompatible with relativeURLs set to true

The gitlab pages rendering of hugo assets requires that the relativeURLs be set to true in config.toml. I've discovered that if you are using a non-root context as your baseURL, then no matter what path you pass to the navigation links, it will construct the wrong url and result in a 404.

Example:

baseURL = "https://examplesite.com/dot/"
relativeURLs = true

# Dropdown menu
[[Languages.en.menu.main]]
weight = 4
name = "docs"
hasChildren = true

  [[Languages.en.menu.main]]
  parent = "docs"
  name = "Installation"
  url = "installation"
  weight = 1

  [[Languages.en.menu.main]]
  parent = "docs"
  name = "Billing and Pricing"
  url = "billing-pricing"
  weight = 2

  [[Languages.en.menu.main]]
  parent = "docs"
  name = "Features"
  url = "features"
  weight = 3

This will result in the navigation url's resolving to /dot/dot/<url> or even /dot/dot/dot/<url>.

Styles/appearance different when deploy to Azure

Hi,
After deploy an Hugo app to Azure (Azure Static Web Site), I found different behavior about Styles.

Attached go two image: Localhost and Azure (production) Styles to know exactly what is happening.

Any idea about how I can solve it?

ia Azure
ia localhost

Thanks a lot

A way to add custom code to header/body tags

I have a use case where I would like to add custom content before the </head> tag. #150 implements that. Users can add locally (either in their overriding theme or in the root directory) add /layouts/partials/overrides/header.html and the content is printed at that location.

I see multiple uses for this, after <body>, before </body>...

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.