Nuxt Wiki

TranslationsDiscordGithub

Pages and Navigation

Overview

This page provides guidelines on how to create pages within the Wiki and how navigation is structured automatically based on your content. Understanding these elements will help you contribute effectively to the Wiki.

Table of Contents

Directory Structure

Pages in this Wiki should be organized within the content directory in a specific format that reflects their priority and structure. The basic organization looks like this:

wiki/
  1.recipes/
    1.breakfast/
      1.pancakes.md
      2.smoothies.md
    2.lunch/
      1.sandwiches.md
      2.salads.md
  2.hobbies/
    1.art/
      1.drawing.md
      2.painting.md
    2.sports/
      1.basketball.md
      2.cycling.md

File Naming and Order

  • Each folder and file is prefixed with a number to indicate its priority.
  • Use folders to group related pages, and number them to determine their order.
  • Directories can contain multiple files (sub-pages), so you can create any structure you need, such as folder/folder/page or simply folder/page.

Example Paths

Based on the above structure, the internal paths would be:

  • content/1.recipes/1.breakfast/1.pancakes.md → /recipes/breakfast/smoothies
  • content/1.recipes/2.lunch/1.sandwiches.md → /recipes/lunch/sandwiches
  • content/1.recipes/2.lunch/2.salads.md → /recipes/lunch/salads
  • content/2.hobbies/1.art/1.drawing.md → /hobbies/art/drawing
  • content/2.hobbies/2.sports/1.basketball.md → /hobbies/sports/basketball

Creating a Page

To create a new page in the Wiki, follow these steps:

  1. Navigate to the relevant section where you want to add the new page.
  2. Create a new Markdown file with a relevant name (e.g., 1.new-topic.md).
  3. Place the file in the appropriate folder, following the naming and numbering conventions.
  4. Add the required metadata at the top of the file, including title and description.
  5. Write your content using Markdown syntax.
  6. Save the file in the appropriate directory structure based on its topic.

Page Metadata

Each page should include metadata at the top in YAML format. This metadata helps in generating navigation and indexing pages. Here’s what to include:

  • title: The title of the page, which will be displayed in the navigation and page header.
  • description: A brief description of the page's content, used for SEO and context.

Example Metadata

---
title: Cooking
description: This page explores cooking as a fun and rewarding hobby.
---

Navigation in the Wiki is generated automatically based on the structure of your pages. When you create a page with a title and proper structure, it will appear in the navigation menu.

To link to other pages, use the following Markdown syntax:

[Link text](link-to-page)

For example, to link to a page titled "Installation":

[Cooking](/wiki/hobbies/cooking)

Best Practices

  • Consistent Naming: Use clear and consistent naming conventions for your pages and links to make them easily identifiable.
  • Logical Structure: Organize pages in a logical hierarchy to improve navigation.
  • Use Descriptive Titles: Ensure that the titles and descriptions of your pages accurately reflect the content to enhance discoverability.
  • Regular Updates: Keep pages updated with relevant information to maintain their usefulness.

By following these guidelines, you can contribute effectively to the Wiki and ensure that it remains a valuable resource for all users.

InstallationFormatting