Skip to content

home.adoc

Latest commit

 

History

History
59 lines (45 loc) · 2.79 KB

home.adoc

File metadata and controls

59 lines (45 loc) · 2.79 KB

This documentation site is running on Wiki.js! {.is-success}

Getting Started

Wiki.js is quick and easy to install. You should be up and running in no time.

  • [Requirements Server and database prerequisites.](/install/requirements)

  • [Installation Guide Detailed installation instructions for all platforms.](/install) {.links-list}

User Guide

  • [The Basics New to Wiki.js? Learn how to use it and create your first page.](/guide/intro)

  • [Folder Structure & Tags Learn how to categorize your pages for an easier browsing experience.](/guide/structure)

  • [Manage Pages How to create, edit and manage your pages.](/guide/pages)

  • [Using Editors Learn how to use the various editors.](/editors)

  • [Using Assets How to upload and manage assets such as images and documents.](/guide/assets) {.links-list}

Administration

  • [:globe_with_meridians: Locales Display the wiki in a different language or enable multilingual capabilities.](/locales)

  • [:busts_in_silhouette: User Groups Permissions and access rights.](/groups)

  • [:satellite: Telemetry Help Wiki.js developers understand crashes by enabling anonymous telemetry.](/telemetry)

  • [:wrench: Troubleshooting Solutions to common issues.](/troubleshooting) {.links-list}

Modules

Modules greatly expand the capabilities of your wiki. - [:lock: Authentication Configure how users can login and register to your wiki.](/auth) - [:speech_balloon: Comments Add discussion capabilities to your wiki.](/comments) - [:pencil: Editors Manage the various editors used to create content.](/editors) - [:hourglass: Rendering Configure how content is parsed and rendered into its readable form.](/rendering) - [:mag: Search Engines Manage the search capabilities of your wiki.](/search) - [:floppy_disk: Storage Backup or sync the content of your wiki with external storage services.](/storage) {.links-list}

Developers

Wiki.js is fully extensible for maximum customization.

  • [:book: Getting Started How to setup a dev environment for Wiki.js.](/dev)

  • [:closed_book: Modules Learn how to create a module.](/dev/modules)

  • [:art: Themes Learn how to create your own theme.](/dev/themes) {.links-list}

Localization

  • [:globe_with_meridians: Translations Contribute a new language or test new keys](/dev/translations) {.links-list}

Contribute