# Best way to include a github project docs inside a Hugo site

**URL:** <https://discourse.gohugo.io/t/best-way-to-include-a-github-project-docs-inside-a-hugo-site/10758>\
**Category:** support\
**Created:** [February 27, 2018, 7:18am UTC](https://discourse.gohugo.io/t/best-way-to-include-a-github-project-docs-inside-a-hugo-site/10758 "2018-02-27T07:18:23Z")\
**Posts on this page:** 2\
**Page:** 1

<div class="post-metadata">

**Author:** ![Tzach\_Livyatan](https://avatars.discourse-cdn.com/v4/letter/t/f07891/32.png) [@Tzach\_Livyatan](https://discourse.gohugo.io/u/Tzach_Livyatan)\
**Post date:** [February 27, 2018, 7:18am UTC](https://discourse.gohugo.io/t/best-way-to-include-a-github-project-docs-inside-a-hugo-site/10758/1 "2018-02-27T07:18:23Z")

</div>

Hello all, newbie question below.  
We are building a Hugo base site for an open source project  
As part (not all) of the site, I want to include HTML rendering of the project /doc directory (Markdown files).  
What is the right way to do so?

I started by creating a git submodule for the opensource project under the Hugo, but I’m not sure what I should do next. What should I change in config.toml to include the submodule in the build?  
Should/can I use a different theme for the submodule

Thanks  
Tzach

Similar topic is discussed in an old thread here

> [@Hugo as a documentation tool](https://discourse.gohugo.io/t/hugo-as-a-documentation-tool/112):
>
> As the documentation of Hugo is rendered by Hugo itself, I wonder if there’s any plan to add some documentation features to Hugo. Actually the main feature I miss is valid for any website: an internal search. I couldn’t find any open issue for this. Maybe it’s outside the scope of Hugo? Would you recommend an external tool? A feature more specific for documentation would be a classic ‘book index’. What do you think about it?

---

<div class="post-metadata">

**Author:** ![RickCogley](https://yyz2.discourse-cdn.com/flex036/user_avatar/discourse.gohugo.io/rickcogley/32/10269_2.png) [@RickCogley](https://discourse.gohugo.io/u/RickCogley)\
**Post date:** [February 27, 2018, 12:06pm UTC](https://discourse.gohugo.io/t/best-way-to-include-a-github-project-docs-inside-a-hugo-site/10758/2 "2018-02-27T12:06:37Z")

</div>

You mean you want to include a pre-rendered set of files? Or, do you mean you want Hugo to render the markdown files into HTML.

If you already have HTML, you can put them under `static` and link to it from the site however you need.

If you want to have Hugo render them, then, this is untested but I would say you could pull a git submodule into `content` like `content/docs`. Their frontmatter would need to be compatible.