Skip to content

Commit

Permalink
user guide update
Browse files Browse the repository at this point in the history
  • Loading branch information
jandecaluwe committed Mar 28, 2014
1 parent fbab262 commit 32df54a
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 12 deletions.
18 changes: 12 additions & 6 deletions _build/user-guide.html
Original file line number Diff line number Diff line change
Expand Up @@ -100,12 +100,18 @@ <h1>How to add user info</h1>
<p>To add user info, please first read the <a href="/site-development.html" title="Site development guide">Site development guide</a>.</p>
<p>MyHDL users can add their info under the <code>/users</code> directory. If a single page
is sufficient, put the info in a <code>&lt;username&gt;.md</code> file. Otherwise, create a
directory <code>&lt;username&gt;</code> and add an <code>index.md</code> and other pages there. There are
some placeholder files and directories to show how it works. You can start by
picking a placeholder and rename it. Use a <code>simple_page</code> layout if you don't
need a sidebar. </p>
<p>Be sure to add the page or folder name in the <code>content</code> field of the
<code>users/index</code>.</p>
directory <code>&lt;username&gt;</code> and add an <code>index.md</code> and other pages there.
In the latter case, use <code>index.md</code> as the main entry point
for your info, it works best for nice urls.</p>
<p>File and directory names map to urls, so avoid whitespace and use
all lowercase names.</p>
<p>There are some placeholder files and directories to show how it works. You can
start by picking a placeholder and rename it. </p>
<p>A typical layout for your content pages would be <code>article</code>. If you don't need a
sidebar, use <code>simple_article</code>. If you need a wider area for the text, use
<code>wide_article</code>.</p>
<p>Be sure to add the page or folder name as a list item entry in the <code>content</code>
field of the <code>users/index</code>.</p>
</div>
</div>
</div>
Expand Down
21 changes: 15 additions & 6 deletions user-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,19 @@ To add user info, please first read the [/site-development].

MyHDL users can add their info under the `/users` directory. If a single page
is sufficient, put the info in a `<username>.md` file. Otherwise, create a
directory `<username>` and add an `index.md` and other pages there. There are
some placeholder files and directories to show how it works. You can start by
picking a placeholder and rename it. Use a `simple_page` layout if you don't
need a sidebar.
directory `<username>` and add an `index.md` and other pages there.
In the latter case, use `index.md` as the main entry point
for your info, it works best for nice urls.

Be sure to add the page or folder name in the `content` field of the
`users/index`.
File and directory names map to urls, so avoid whitespace and use
all lowercase names.

There are some placeholder files and directories to show how it works. You can
start by picking a placeholder and rename it.

A typical layout for your content pages would be `article`. If you don't need a
sidebar, use `simple_article`. If you need a wider area for the text, use
`wide_article`.

Be sure to add the page or folder name as a list item entry in the `content`
field of the `users/index`.

0 comments on commit 32df54a

Please sign in to comment.