https://github.com/estruyf/doctor

Doctor - Maintain your documentation on SharePoint without pain.
https://github.com/estruyf/doctor

documentation markdown sharepoint

Last synced: 12 days ago
JSON representation

Doctor - Maintain your documentation on SharePoint without pain.

• Host: GitHub
• URL: https://github.com/estruyf/doctor
• Owner: estruyf
• License: mit
• Created: 2020-12-11T13:56:48.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2024-10-11T07:21:43.000Z (about 1 month ago)
• Last Synced: 2024-10-12T07:56:30.279Z (about 1 month ago)
• Topics: documentation, markdown, sharepoint
• Language: TypeScript
• Homepage: http://getdoctor.io
• Size: 649 MB
• Stars: 116
• Watchers: 8
• Forks: 18
• Open Issues: 41
• Metadata Files:
  • Readme: readme.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        


  

    

  



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](https://pnp.github.io/cli-microsoft365/).

> Today `doctor` is maintained by `Elio Struyf`.

## Documentation

More information about how you can use `doctor` can be found in our documentation: [getdoctor.io](https://getdoctor.io).

> The beta docs can be found on [beta.getdoctor.io](https://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:

```bash

npm i -g @estruyf/doctor

```

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

```bash

yarn global add @estruyf/doctor

```

To quickly get started, we provided a [sample repository](https://github.com/estruyf/doctor-sample) which allows you to test out all the functionalities of `Doctor`.

## Todo

All ideas can be found in our [issue list](https://github.com/estruyf/doctor/issues) tagged with [enhancement](https://github.com/estruyf/doctor/issues?q=is%3Aissue+is%3Aopen+label%3Aenhancement).

## Found an issue?

Please add all your issues to the project [issue list](https://github.com/estruyf/doctor/issues).

## 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](https://github.com/estruyf/doctor/discussions) and let us know what you want to implement.

Feedback can also be provided to the [discussion list](https://github.com/estruyf/doctor/discussions).

## 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.**