gohugoio / hugoThemes

A curated directory of Hugo themes
https://themes.gohugo.io/
MIT License
1.77k stars 242 forks source link

Please add docdock to the themes directory #253

Closed vjeantet closed 7 years ago

vjeantet commented 7 years ago

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

thanks

bep commented 7 years ago

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.

bep commented 7 years ago

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
vjeantet commented 7 years ago

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.

vjeantet commented 7 years ago

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

exampleSite comited

bep commented 7 years ago

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.

digitalcraftsman commented 7 years ago

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.

bep commented 7 years ago

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

digitalcraftsman commented 7 years ago

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

ghost commented 7 years ago

Got themes? Yes, many

digitalcraftsman commented 7 years ago

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

bep commented 7 years ago

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.

vjeantet commented 7 years ago

I'm on it

vjeantet commented 7 years ago
vjeantet commented 7 years ago

Hello,

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

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

bep commented 7 years ago

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

vjeantet commented 7 years ago

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

vjeantet commented 7 years ago

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}}
bep commented 7 years ago

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.

bep commented 7 years ago

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

vjeantet commented 7 years ago

the good part related to v0.22 are

bep commented 7 years ago

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.