I am new in the static site generator world. However, I have used MkDocs for a while to build what I wanted. Unfortunately, I failed. The point where I got stuck was MkDocs didn’t let me build a site with collapsible navigation of a tree of pages. All nodes were flat opened.
I needed something that would support it and here I am trying my 2nd static site generator.
Imagine I have a folder full of md files and they could be in a hierarchy of folders at most 3 levels deep. I need to generate a static site from the .md files that generates a navigation tree on the left side or right side of the browser. Since there can be many pages I need expand/collapse option.
Please advice how I can generate a site from such a document folder structure and what theme would best suite this.
P.S. I see Hugo is blog aware and has to do many things with blogs. I do not have anything to do with blog and do not want to see any blog type elements for my site.
Hi and welcome!
Wich ever tools you use if it’s MkDocs or Hugo you can add a collapsible menu.
With Bootstrap which is a framework for developing responsive, mobile first projects on the web, you could build a menu like this: http://www.bootply.com/KCmBhDKl6j
Here is a Hugo site that has a left side collapsible tree menu: https://docs.camunda.org/
and here is another: http://vamp.io/documentation/how-vamp-works/architecture-and-components/
Your folder structure does not have to mirror the navigation structure. Keep the folder structure as flat as possible and structure content with taxonomies, check out this: http://gohugo.io/taxonomies/overview/
One theme you could use is the Camunda BPM. I have not found it in the http://themes.gohugo.io/ so you have to research and dig a little bit.
Hope this helps!
Thank you so much for taking the time and responding with useful information. Your links showed me that there are a couple sites that is exactly what I am looking for.
However, I would like to point out a few things that is missing in this response which I was looking for in the original request.
"Wich ever tools you use if it’s MkDocs or Hugo you can add a collapsible menu."
I have already spent enough time with MkDocs and it doesn’t have a theme that would support a collapsible navigation tree. If I or somebody has to do development to get this feature then we have to say it is missing the feature. Anything can be built/added to any platform that is understood. But is it already there that I can use is the prime question.
So does Hugo have a theme that supports it right now?
Second - My folder structure is a mirror of my source control structure and initially this is what I want to mirror in the doc site. Sure - I can play with organization later but I want to see if something can be built on the spot without any work on Hugo elements (e.g. Taxonomy, Categories etc.). MkDocs is beautiful in that way. Throw it a folder and it generates a navigation from it. It builds a TOC/navigation from the folder structure. Can Hugo do it? Is there a tutorial or guide that shows how to do it?
Both the Camunda and the Vamp type site would work for my purpose. In fact the Hugo documentation site also uses collapsible menu. What theme are they using? How can I get the Camunda or Vamp theme?
To summarize, I would really appreciate information on these two things
- Is there a way to generate a site from a folder tree with a bunch of .md files? Just like MkDocs? Any tips or tutorial/guide reference available?
- Is there a theme that come with Hugo theme repos that would do a collapsible navigation. Please give me the name of the theme.
Ok. I see the Hugo docs in GIT repo and could run it locally using Hugo. I don’t see a theme being used but there’s bunch of stuff in the static folder doing what a theme is supposed to do. This gives me a good base to work on.
For my question 1. I think I know what needs to be done here.
For 2. A reference to a theme that supports collapsible tree like navigation will be still useful.
Hi, you already shared these two earlier. But how could I get the themes for these? Also it would be nice if I could see the source structure so I know how to craft mine.
Also my critical question is - if there is any theme in the Hugo theme repos that supports the collapsible navigation right now?
Vamp seems to support two level of hierarchy on the left navigation panel. Camunda seems to go deeper.