@estruyf/doctor

Maintain your documentation on SharePoint without pain

Doctor was originally created for having a uniformal way of providing the documentation internally at Valo Solutions. The main driver for doctor was to dogfood the Valo products and make it easier for users to maintain documentation on SharePoint.

As we understand that it is not the best experience for developers to write documentation on SharePoint, we created this tool to simplify the process. Doctor allows developers to use tools/applications they are used to, like VSCode and Markdown, and still provide the information on your SharePoint environment.

Doctor follows the concept of many Static Site Generators. These generators make it possible to write your articles/documentation in Markdown and convert them to HTML files.

Doctor is a bit different, as instead of creating HTML files, it makes SharePoint pages instead.

Under the hood, it makes use of the CLI for Microsoft 365.

Today doctor is maintained by Elio Struyf.

Documentation

More information about how you can use doctor can be found in our documentation: getdoctor.io.

The beta docs can be found on beta.getdoctor.io.

Installation

Thank you for your interest in the doctor. The following information will help you install doctor.

Start by installing doctor as follows via npm:

npm i -g @estruyf/doctor

If you are using yarn, you can do it as follows:

yarn global add @estruyf/doctor

To quickly get started, we provided a sample repository which allows you to test out all the functionalities of Doctor.

Todo

All ideas can be found in our issue list tagged with enhancement.

Found an issue?

Please add all your issues to the project issue list.

Feedback / Contribute

If you want to contribute to the project, feel free to do so. Best is to start a discussion in the discussion list and let us know what you want to implement.

Feedback can also be provided to the discussion list.

Disclaimer

THIS CODE IS PROVIDED AS IS WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING ANY IMPLIED WARRANTIES OF FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY, OR NON-INFRINGEMENT.