Project: ShardingSphere (App Definition and Development / Database)
File: _index.en.md

date: 2016-04-09T16:50:16+02:00 title: Pages organization weight: 5 In Hugo, pages are the core of your site. Once it is configured, pages are definitely the added value to your documentation site. Organize your site like . Typically, you will have a content folder with all your pages. content level-one level-two level-three level-four _index.md <-- /level-one/level-two/level-three/level-four page-4-a.md <-- /level-one/level-two/level-three/level-four/page-4-a page-4-b.md <-- /level-one/level-two/level-three/level-four/page-4-b page-4-c.md <-- /level-one/level-two/level-three/level-four/page-4-c _index.md <-- /level-one/level-two/level-three page-3-a.md <-- /level-one/level-two/level-three/page-3-a page-3-b.md <-- /level-one/level-two/level-three/page-3-b page-3-c.md <-- /level-one/level-two/level-three/page-3-c _index.md <-- /level-one/level-two page-2-a.md <-- /level-one/level-two/page-2-a page-2-b.md <-- /level-one/level-two/page-2-b page-2-c.md <-- /level-one/level-two/page-2-c _index.md <-- /level-one page-1-a.md <-- /level-one/page-1-a page-1-b.md <-- /level-one/page-1-b page-1-c.md <-- /level-one/page-1-c _index.md <-- / page-top.md <-- /page-top {{% notice note %}} `_index.md` is required in each folder, its your folder home page {{% /notice %}} Hugo-theme-learn defines two types of pages. Default and Chapter. Both can be used at any level of the documentation, the only difference being layout display. A Chapter displays a page meant to be used as introduction for a set of child pages. Commonly, it contains a simple title and a catch line to define content that can be found under it. You can define any HTML as prefix for the menu. In the example below, it's just a number but that could be an . ```markdown +++ title = "Basics" chapter = true weight = 5 pre = "<b>1. </b>" +++ Discover what this Hugo theme is all about and the core-concepts behind it. ``` To tell Hugo-theme-learn to consider a page as a chapter, set `chapter=true` in the Front Matter of the page. A Default page is any other content page. ```toml +++ title = "Installation" weight = 15 +++ ``` The following steps are here to help you initialize your new website. If you don't know Hugo at all, we strongly suggest you to train by following this . Hugo provides a `new` command to create a new website. ``` hugo new site <new_project> ``` Hugo-theme-learn provides to help you create this kind of pages. Each Hugo page has to define a in yaml, toml or json. Hugo-theme-learn uses the following parameters on top of Hugo ones : ```toml +++ disableToc = "false" menuTitle = "" pre = "" post = "" chapter = false hidden = false LastModifierDisplayName = "" LastModifierEmail = "" +++ ``` In the page frontmatter, add a `pre` param to insert any HTML code before the menu label. The example below uses the Github icon. ```toml +++ title = "Github repo" pre = "<i class='fab fa-github'></i> " +++ ``` Hugo provides a to handle order for your pages. The simplest way is to set `weight` parameter to a number. ```toml +++ title = "My page" weight = 5 +++ ``` By default, Hugo-theme-learn will use a page's `title` attribute for the menu item (or `linkTitle` if defined). But a page's title has to be descriptive on its own while the menu is a hierarchy. We've added the `menuTitle` parameter for that purpose: For example (for a page named `content/install/linux.md`): ```toml +++ title = "Install on Linux" menuTitle = "Linux" +++ ``` To configure your home page, you basically have three choices: Create an `_index.md` document in `content` folder and fill the file with Markdown content Create an `index.html` file in the `static` folder and fill the file with HTML content Configure your server to automatically redirect home page to one your documentation page