How to format your code for LiveDoc
- For now, your repository must be hosted in GitHub. We’re working on extending LiveDoc functionality to include code repositories hosted in DevOps, but our initial focus was GitHub.
- You need to give us a personal access token to access the GitHub repository, with read-only privileges.
- You need to update your README.md to add section markers that help to extract the relevant text blocks.
Example:
<!-- Section: Overview -->
## Overview
Project 'Hello World' is a web-based application...
<!-- Section: Configuration -->
## Configuration
Clone the repository...
<!-- Section: Installation -->
## Installation
Install the npm packages...