Publish Markdown Documentation

Mddocs supports .md files as a source files for your documentation pages. By default Mddocs uses index.md file located in the documentation source folder to create index.html of you documentation website. If the file is missing, Mddocs application will look for the README.md file in the source folder of your repository.

Prerequisites

We assume you have completed the following steps in advance:

  • There is a GtHub repository with markdown documentation
  • Mddocs GitHub application is installed into your account
  • You provided Mddocs application an access to the repository in the Installed GitHub App page

Publish documentation website

In order to publish the documentation open Mddocs Dashboard and find the card of the repository you want to publish. Click on the Publish button:

publish docs

Wait for publication status to become Published. This status means that the publication succeeded and the website is available for the users:

published docs

Green check icon next to the repository Url represents the Published status:

published docs

Also, when the documentation is published, the status text is displayed on the repository card. The text displays the date and time of the publication as well as the link to the commit that was used for the publication.

published docs

You can visit the generated website by clicking on the External link icon:

published docs

See also