This wiki serves as a central hub for documentation and department policies
Welcome to the team wiki! This guide will help you get started with using Wiki.js, including how to create, edit, organize, and navigate pages effectively.
Before you begin creating or editing content, make sure you:
- Have access to the Wiki platform (you should be logged in).
- Understand the basic structure of how our wiki is organized (see Organizing Pages).
- Know your team's naming conventions and guidelines (see Best Practices).
You can access the wiki here: https://your-wiki-url.com
Here’s how to find your way around the wiki:
- Sidebar Menu: Located on the left. It shows the page hierarchy and navigation tree.
- Search Bar: Quickly find any page by typing keywords or titles.
- Breadcrumbs: At the top of each page. Helps you see where you are in the page structure.
- Tags: Pages can be tagged to group related content. Clicking a tag will show all related pages.
-
Navigate to the Appropriate Location
- Use the sidebar to find the section where your new page should live.
- Select the parent page or folder.
-
Click “New Page”
- Use the “+” or “New Page” button usually located at the top or side of the page list.
-
Enter Page Details
- Title: Use a clear and descriptive title.
- Path: This determines the URL. Keep it short and meaningful.
- Editor: Choose the editor (typically Markdown is used for consistency).
-
Add Content
- Use Markdown or WYSIWYG editor depending on your preference.
- Use headers (
#, ##, ###) to create structure.
- Include links to related pages using
[Page Name](/path-to-page).
-
Save or Publish
- Save your draft or click Publish to make it live.
- Hierarchy: Pages can be nested inside other pages to form a tree structure. Use this to group related content.
- Example:
Projects > Project X > Reports
- Folders: Wiki.js allows folders to better organize large sets of pages.
- Tags: Use tags to group content across different categories.
- Ordering: You can manually reorder pages in the navigation menu for logical flow.
Home
│
├── Company Info
│ ├── Mission & Values
│ └── Team Directory
│
├── Projects
│ ├── Project A
│ │ ├── Overview
│ │ └── Reports
│ └── Project B
│
├── Processes
│ ├── Onboarding
│ └── Code Review Guidelines
│
└── Resources
├── Tools
└── Documentation
¶ ✏️ Editing and Formatting Pages
- Use Markdown syntax for consistency:
# Heading 1, ## Heading 2**bold**, _italic_- Bullet points:
- Item
- Code blocks: ``` for multiline
- Link to other wiki pages using:
[Page Name](/path/to/page)
- Add images or files using the attachment or media manager.
# Heading 1
## Heading 2
**Bold Text**
- Bullet Item
- Another Item
[Link to Google](https://www.google.com)
- Be Consistent: Follow the naming conventions and formatting rules.
- Be Concise: Get to the point, but ensure completeness.
- Use Headings: Break long content into readable sections.
- Link Often: Connect pages to reduce duplication and improve navigation.
- Review Before Publishing: Proofread for typos, clarity, and accuracy.
- Use Title Case for page titles:
Project Overview
- Use lowercase-hyphenated for paths:
/project-overview
If you get stuck:
- Check the Wiki.js Documentation
- Ask a team lead or admin for help
- Contact the internal documentation team
Let’s keep this wiki clean, useful, and up-to-date for everyone. Happy documenting! 📝