https://queil.net/tags/docs/ Recent content in Docs on queil.net Hugo en-uk Sun, 25 Oct 2020 11:57:16 +0000 https://queil.net/2020/10/docs-for-your-open-source-project-in-5-minutes/ Sun, 25 Oct 2020 11:57:16 +0000 https://queil.net/2020/10/docs-for-your-open-source-project-in-5-minutes/ <p>I&rsquo;ve been using <a href="https://gohugo.io/">Hugo</a> for a while and it also powers this blog. However, for my tiny <a href="https://github.com/queil/yzl">Yzl</a> project I wanted GitHub Pages docs that look like <a href="https://argoproj.github.io/argo-cd/getting_started/">this</a>. I&rsquo;ve seen it in numerous open-source projects and I liked the material design look. If you like it too, please keep reading.</p> <h1 id="what-is-it" class="anchor-link"><a href="#what-is-it">What is it?<span class="pilcrow">&nbsp;¶</span></a></h1> <p>After a quick research I have found out that the tool is <a href="https://www.mkdocs.org/">mkdocs</a> and the theme I want is <a href="https://github.com/squidfunk/mkdocs-material">squidfunk/mkdocs-material</a>. 2 minutes later I started playing with mkdocs. In the root of my repo I created <code>docs</code> folder with a placeholder <code>index.md</code> and ran:</p>