The documentation viewer plugin eases the management of a markdown based documentation contained within a repository.
\nThe configuration of this plugin is done via a documentation.yaml file, contained in the root directory of the corresponding repository.\nAlternatively it is also possible to use a documentation.yml file instead.\nBut it is not allowed to have both files in the root directory of the repository.
In this yaml file a user can configure two properties.\nThe first one is basePath.\nbasePath allows the user to determine in which directory of the repository the documentation is stored.\nThe second one is landingPage.\nThis allows the user to determine which file in the documentation directory is the landing page of the documentation.\nSince this plugin only supports markdown files, the name of the landing page needs to have .md as a file extension.\nThe following shows an example configuration:
basePath: '/docs'\nlandingPage: 'home.md'With this configuration, the plugin assumes, that the documentation is stored under the /docs directory of the repository.\nIt also assumes the home.md file is supposed to be present at that directory and should be used as a landing page.\nBoth values are optional and are not required to be set.\nIf they are not set, a default value will be used.\nThe default values can also be seen in the example above.
As soon the plugin is configured properly, a navigation link to the documentation appears.\nThis navigation link can be seen in the repository side bar navigation.\nBy clicking this link, the user gets redirected to the landing page.
\n