General

Name

Internal name of the Documentation (not publicly visible) for your own use.

Site name

Name of the Documentation that will be used as its Title in the published version.

Properties

Enabled

With this switch, you can quickly make whole Documentation available un unavailable online.

Default

You can make one of the Documentations within the scope of Project the default one. The *default * Documentation means it will be the one that opens up when somebody accesses the domain of the Project.

Example

If you have a Project named “My Project” and you can access it via https://my-project.docwriter.io and you have 2 Documentations:

  1. “User manual” - the DEFAULT
  2. “Technical documentation” - the NON DEFAULT

Then opening https://my-project.docwriter.io will lead to opening the 1st documentation “User manual”

Localization

Available languages

A set of Languages you are going to enter the contents of the Documentation in. You will be able to switch between the Languages in the Content sections.

Default language

The default language to be loaded when viewing the published version of the Documentation without language GET parameter specified in the URL.

Remember

The default language is not a fallback language!

If you don’t enter any content in a specific language, it will stay empty. So, use the Published feature switches in the Content sections to define which Content pages should be published under a certain language.

Theme

Different looking visual themes for the published version of the Documentation.

Last updated information

Choose different ways to display when a page was updated and the user that updated it. This will be shown in the top right corner of a page.

Design

By using this section, you can override the default visual appearance of the published Documentation.

  1. Use the little widgets to change colors, fonts, and logos
  2. Use the Custom styles text input to apply your own, custom CSS 1 stylesheet

Security

If you want to protect the published version of the Documentation with credentials, you can create as many pairs of usernames and passwords as required.

Remember

Remember to click the Publish button after making changes to the Credentials entries

Tracking

Google Analytics tracking ID

Enter the Google Analytics tracking code, if you wish to use Google Analytics with the published version of the Documentation.