ykxiao/laradock
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

move _guides to the documentation

Browse Source
This commit is contained in:
Mahmoud Zalt
2017-04-14 04:43:26 -04:00
parent 3a7e6e4b1a
commit 5a496bafeb
47 changed files with 1840 additions and 315 deletions
Download Patch File Download Diff File Expand all files Collapse all files

40
docs/contributing/index.html
View File

@ -211,6 +211,24 @@
<a title="Giudes" href="http://laradock.io/guides/">
Giudes
</a>
</li>
<li>
<a title="Related Projects" href="http://laradock.io/related-projects/">
Related Projects
@ -345,20 +363,20 @@ features, by not reporting duplicate issues.</em></p>
<p>Laradock uses <a href="https://gohugo.io/">Hugo</a> as website generator tool, with the <a href="http://themes.gohugo.io/theme/material-docs/">Material Docs theme</a>. You might need to check their docs quickly.</p>
<ol>
<li>Install <a href="https://gohugo.io/">Hugo</a> on your machine (easy thing).</li>
<li>Open the <code>DOCUMENTATION/_settings/content</code> and search for the markdown file you want to edit (every folder represents a section in the menu).</li>
<li>Delete the <code>/docs</code> folder from the root.</li>
<li>When you finish editing, go to <code>DOCUMENTATION/_settings/</code> and run the <code>hugo</code> command to generate the HTML docs (inside new <code>/docs</code> folder).</li>
</ol>
<p>Go the <code>DOCUMENTATION/_settings/content</code> and search for the markdown file you want to edit (every folder represents a section in the menu).</p>
<p>To edit the sidebar or add a new section, you need to edit this file <code>DOCUMENTATION/_settings/config.toml</code> as well.</p>
<p><em>The site will be autogenerated in the <code>docs/</code> folder by <a href="https://travis-ci.com/">Travis</a>.</em></p>
<h3 id="to-host-the-website-locally">To Host the website locally</h3>
<p>Go to <code>DOCUMENTATION/_settings</code> in your terminal and run <code>hugo serve</code> to host the website locally.</p>
<h3 id="edit-the-sidebar">Edit the sidebar</h3>
<p>To add a new section to the sidebar or edit existing one, you need to edit this file <code>DOCUMENTATION/_settings/config.toml</code>.</p>
<ol>
<li>Install <a href="https://gohugo.io/">Hugo</a> on your machine (easy thing).</li>
<li>Edit the <code>DOCUMENTATION/_settings/content</code>.</li>
<li>Delete the <code>/docs</code> folder from the root.</li>
<li>When you finish editing, go to <code>DOCUMENTATION/_settings/</code> and run the <code>hugo</code> command to generate the HTML docs (inside new <code>/docs</code> folder).</li>
</ol>
<h2 id="how-to-support-new-software-add-new-container">How to support new Software (Add new Container)</h2>

22
docs/contributing/index.xml
View File

@ -48,20 +48,20 @@ features, by not reporting duplicate issues.&lt;/em&gt;&lt;/p&gt;
&lt;p&gt;Laradock uses &lt;a href=&#34;https://gohugo.io/&#34;&gt;Hugo&lt;/a&gt; as website generator tool, with the &lt;a href=&#34;http://themes.gohugo.io/theme/material-docs/&#34;&gt;Material Docs theme&lt;/a&gt;. You might need to check their docs quickly.&lt;/p&gt;
&lt;ol&gt;
&lt;li&gt;Install &lt;a href=&#34;https://gohugo.io/&#34;&gt;Hugo&lt;/a&gt; on your machine (easy thing).&lt;/li&gt;
&lt;li&gt;Open the &lt;code&gt;DOCUMENTATION/_settings/content&lt;/code&gt; and search for the markdown file you want to edit (every folder represents a section in the menu).&lt;/li&gt;
&lt;li&gt;Delete the &lt;code&gt;/docs&lt;/code&gt; folder from the root.&lt;/li&gt;
&lt;li&gt;When you finish editing, go to &lt;code&gt;DOCUMENTATION/_settings/&lt;/code&gt; and run the &lt;code&gt;hugo&lt;/code&gt; command to generate the HTML docs (inside new &lt;code&gt;/docs&lt;/code&gt; folder).&lt;/li&gt;
&lt;/ol&gt;
&lt;p&gt;Go the &lt;code&gt;DOCUMENTATION/_settings/content&lt;/code&gt; and search for the markdown file you want to edit (every folder represents a section in the menu).&lt;/p&gt;
&lt;p&gt;To edit the sidebar or add a new section, you need to edit this file &lt;code&gt;DOCUMENTATION/_settings/config.toml&lt;/code&gt; as well.&lt;/p&gt;
&lt;p&gt;&lt;em&gt;The site will be autogenerated in the &lt;code&gt;docs/&lt;/code&gt; folder by &lt;a href=&#34;https://travis-ci.com/&#34;&gt;Travis&lt;/a&gt;.&lt;/em&gt;&lt;/p&gt;
&lt;h3 id=&#34;to-host-the-website-locally&#34;&gt;To Host the website locally&lt;/h3&gt;
&lt;p&gt;Go to &lt;code&gt;DOCUMENTATION/_settings&lt;/code&gt; in your terminal and run &lt;code&gt;hugo serve&lt;/code&gt; to host the website locally.&lt;/p&gt;
&lt;h3 id=&#34;edit-the-sidebar&#34;&gt;Edit the sidebar&lt;/h3&gt;
&lt;p&gt;To add a new section to the sidebar or edit existing one, you need to edit this file &lt;code&gt;DOCUMENTATION/_settings/config.toml&lt;/code&gt;.&lt;/p&gt;
&lt;ol&gt;
&lt;li&gt;Install &lt;a href=&#34;https://gohugo.io/&#34;&gt;Hugo&lt;/a&gt; on your machine (easy thing).&lt;/li&gt;
&lt;li&gt;Edit the &lt;code&gt;DOCUMENTATION/_settings/content&lt;/code&gt;.&lt;/li&gt;
&lt;li&gt;Delete the &lt;code&gt;/docs&lt;/code&gt; folder from the root.&lt;/li&gt;
&lt;li&gt;When you finish editing, go to &lt;code&gt;DOCUMENTATION/_settings/&lt;/code&gt; and run the &lt;code&gt;hugo&lt;/code&gt; command to generate the HTML docs (inside new &lt;code&gt;/docs&lt;/code&gt; folder).&lt;/li&gt;
&lt;/ol&gt;
&lt;h2 id=&#34;how-to-support-new-software-add-new-container&#34;&gt;How to support new Software (Add new Container)&lt;/h2&gt;