Shulou(Shulou.com)06/03 Report--

Wiki.js, an open source project based on NodeJS technology, has a simple and beautiful interface and flexible rights management, supporting a variety of editors, multiple user authentication methods, multiple backup storage methods, a variety of search engines, internationalization, custom themes (Theme), traffic analysis and so on. More features are under development and are believed to be available soon.

A modern, lightweight and powerful wiki app built on Node.jsThe most powerful and extensible open source Wiki software

Current version: 2.1.113

GitHub address: Requarks wiki

Supported platform

DockerHerokuLinuxmacOSWindows will soon support Kubernetes

Supported databases

PostgreSQL 9.5 or laterMySQL 8.0 or laterMariaDB 10.2.7 or laterMS SQL Server 2012 or laterSQLite 3.9 or later

Authentication mode

Auth0Azure Active DirectoryDiscordDropboxGitHubGitLabKeycloakLDAP / Active DirectoryLocalOktaSAML 2.0Slack...

Storage mode

Amazon S3Azure Blob StorageDigitalOcean SpacesGitLocal File SystemSFTP...

Search engine

AWS CloudSearchAlgoliaAzure SearchDatabaseElasticsearch... Minimalist installation

Node.js version: 10.12 or later

Take Windows as an example:

Download Wiki.js and extract it, go to the root directory, copy config.sample.yml, and rename it config.yml to edit config.yml.

The default configuration uses the PostgreSQL database, as follows:

Db: type: postgres # PostgreSQL / MySQL / MariaDB / MS SQL Server only: host: localhost port: 5432 user: wikijs pass: wikijsrocks db: wiki ssl: false installation configuration database launch Wiki.jsnode server access Wiki.js complete the installation wizard

Your HOME page can be created after the installation has successfully logged in:

Internationalization

Wiki.js supports multiple languages. To enable other languages, click the Account icon in the upper right corner, select Administration, enter the Locale menu, download the language you want to enable, and then enable Multilingual Namespaces-> Active Namespaces:

Select Locale when creating a new page, and you can create pages for different languages. When browsing wiki, click the Language icon in the upper right corner to switch languages.

Edit wiki page layout

Currently, only one theme is provided, which can be switched to Dark Mode; and does not support custom templates and can not flexibly adjust the layout.

Naming restriction

The following path is reserved for system use and cannot be used for content.

Single-character pages

All single-character paths are reserved for accessing parts of the Wiki:

A: Administration Areae: Page Editorf: Assets Managerh: Page Historyi: Browse Page by IDp: User Profiles: Page Sourcet: Tagsu: Upload Endpoint (API) w: Personal Wiki

IETF Language tags

Language tags in the following format are reserved for specifying the region namespace:

Two-letter language code (e.g. En, fr) Country specific locale code (e.g. En-us, fr-ca)

Special words

The path cannot exactly match the following terms, nor can it be the first part of the path. For example, register or register/test is invalid.

Browserconfig [.xml] cssfavicon [.ico] faviconsfontsgraphqlhealthzhome (reserved for the root homepage) imgjsloginlogoutmanifest [.json] registersvgMarkdown

The most commonly used editor is Markdown,Wiki.js that supports all CommonMark specification and some useful extensions, providing common syntax toolbars. Please refer to the official Markdown documentation for syntax.

A few examples:

Code highlight

Custom picture size

! [Image] (/ link/to/image.jpg = 100x)! [Image] (/ link/to/image.jpg = x50)! [Image] (/ link/to/image.jpg = 100% x)

Add styles to an unordered list

-Grid Item 1-Grid Item 2-Grid Item 3 {.grid-list}-[Lorem ipsum dolor sit amet * Subtitle description here*] (https://www.google.com)- [Consectetur adipiscing elit * Another subtitle description here*] (https://www.google.com)- [Morbi vehicula aliquam * Third subtitle description here*] (https://www.google.com){.links-list})

Note that separators should be added between styles.

Task list

-[x] Checked task item- [x] Another checked task item- [] Unchecked task item

Emojis

: apple:Can be also be used: fire: inline permission management

Wiki.js has a powerful permissions system that allows fine-grained control of what users can see and manipulate.

Based on the definition of group permissions by Permissions and Page Rules, a user can belong to one or more groups and can flexibly restrict the parts that the user accesses and the actions he performs.

Permissions

Page Rules

Welcome to subscribe "Shulou Technology Information " to get latest news, interesting things and hot topics in the IT industry, and controls the hottest and latest Internet news, technology news and IT industry trends.