Skip to content

User Guide: Wiki.js

Gabriel Vîjială edited this page Mar 28, 2023 · 16 revisions

This is EIC network's collaborative knowledge base, that grows stronger with every EIC project. A detailed guide to Wiki.js is available here: https://docs.requarks.io/.

Below some of the key functionalities debunked:

Your Wiki.js. Account



Clicking on the 'Account' icon will lead you to a 'Profile' dashboard as well as to the 'Pages' that you've created.



Create Page

Wiki.js allows for both folders with nested pages or just standalone pages.

On the homepage, please check out the side bar on the left-hand, to view what folders and/or pages have been already created.



To create a new standalone page, just click on the 'Page plus' sign at the top right corner. Please note that the 'Settings' wheel only appears if you are an admin.



Type the new path name and click select. Paths are also referred to as 'Breadcrumbs'.



You will be prompted to select an editor. Wiki.js offers various editors depending on the type of content you want to write. Make sure to choose the 'Visual Editor' for rich text capabilities. Developers will usually go with the 'Markdown' editor.





Next, you will land on the 'Page Properties' view where you will create your page title and description as well as assign some tags. Make sure to click the 'Ok' button, at the top right corner.



Tags are a great way to categorize your pages and easily find related content. You can search and browse pages by tags, by clicking on the tag icon next to the top search bar.



You will return to the visual editor to populate your page with rich content. Make sure to hit the green 'Create' button.



To edit, duplicate, move or delete existing pages, click on the 'Page Actions' sign.



When deleting a page, you will be asked again, to avoid errors.



To create a page within an existing folder (or an existing namespace), choose an existing path and just add the page name to the existing path. DO NOT put a trailing slash, when adding to the existing path. Make sure to click the 'Ok' button at the top right corner.



You cannot create pages utilizing the same path name. An error notification will pop up to let you know to change the name.

Comments

Comments modules add discussion capabilities to your pages. Type in your comment below the page of your choice and click on the 'Post Comment' button.

Sharing & Printing your pages

These capabilities are available next to each individual page on the right side menu.



Clicking on the 'Print' icon will download a PDF format of the respective page, on your computer.

Groups

A user can be part of one or more groups. A group defines what users can see and what they can do. Groups are created and managed by admins.


Back to our detailed User Guide.