Hugothemes: Please add docdock to the themes directory

Created on 29 Apr 2017  路  21Comments  路  Source: gohugoio/hugoThemes

Theme repo here : https://github.com/vjeantet/hugo-theme-docdock

Demo and Documentation here : http://docdock.netlify.com/

This theme is fully designed for documentation. it supports

  • Nested menu
  • Search
  • Markdown to reveal.js slideshow

thanks

All 21 comments

This is really good, finally someone who understood my "custom output feature" ... I will let @digitalcraftsman look at this before we merge it, but it would have been great if you could have put the demo as a subfolder named "exampleSite" in the theme itself. The build script will fall back on a "default example site" if exampleSite is not present, and that will not show your theme from its best side.

Also, if that messes with your own demo, I would recommend Netlify (free for open source).

I recently added my theme's example site there with these (magic) settings:

hugo-netlify-examplesite

Thanks @bep I will put an examplesite.

Before using a index.json i created a custom LUNRJS outputformat, but I found config.toml too verbose for a unique and simple json.

wooo easy :) https://docdock.netlify.com/

exampleSite comited

The search doesn't work via https on your Netlify site (works fine in http) -- looks some HTTP referencing of the JSON file. I would recommend you have a look at my baseURL example above, which will solve most issues of this type.

Hi @vjeantet,

it's great to see another fantastic documentation theme :+1:

~I had a look at your theme by using the build script for the theme site. It's a bit pedantic by requiring a static folder inside the exampleSite directory in order to build a demo. You can leave it empty if you don't need it and make it trackable with an empty file, e.g. .gitkeep. There's already an issue to address this.~

Except the issue with the aforementioned search it's ready to be merged.

@digitalcraftsman I can fix the /static issue now -- and merge this theme while I'm at it, if that is OK.

I can fix the /static issue now -- and merge this theme while I'm at it, if that is OK.

Sure, and please update the notes in the README accordingly while removing this necessity. This would also close #236

Got themes? Yes, many

@bep do you also share the theme on Twitter or should I do it?

I can do it, but I notice the "home page" link is wrong, so I will give him a chance to fix that before I "announce it to the world". He deserves the credits.

I'm on it

  • [x] search https
  • [x] homepage link

Hello,

for info docdock theme updated to use nested sections instead of menus.

Thanks a lot your all your work (cc @bep) !

So, did my implementation actually work?! :-)

yep !

I had headaches to build breadcrumb and to identify parents sections..

maybe a Page.SubSections, Page.InSubsections Page.InParentSections should be added to hugolib...

I had to use a trick like this one to find if a section is a parent to the current one.

{{if hasPrefix $currentNode.URL .URL }}parent{{end}}

Write your suggestions in a GH issue in Hugo repo ... I had some ideas myself, but I did not want to add/commit to too much API before we could test it out.

I'm updating the themes repo now -- curious to see it in action.

the good part related to v0.22 are

A tip: You don't need _index.md on every node in the tree, only the "bottom node". But it is of course useful to get proper titles etc.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

heyarviind picture heyarviind  路  7Comments

onedrawingperday picture onedrawingperday  路  7Comments

kdevo picture kdevo  路  4Comments

spech66 picture spech66  路  3Comments

EmielH picture EmielH  路  3Comments