9f6b1bc1b8
* Clean up tree structure and add proper logo * Proper logo files * Initial docs * Pick up new page after merging main * Apply suggestions from code review Some nits Co-authored-by: Niraj Tolia <ntolia@users.noreply.github.com> * Quash a bunch of Vale prose linter errors, warnings, and suggestions. * PR Review feedback * Simplified mount folders * Cleaned up windows container * Hid `latest` release tag * Review feedback: Link to repo page * Better arrow symbol Co-authored-by: Niraj Tolia <ntolia@users.noreply.github.com> * Clarify sentence * Update README.md * Reframing focus to M365 * More linting * Use only MD files Co-authored-by: Niraj Tolia <ntolia@users.noreply.github.com>
61 lines
1.4 KiB
Markdown
61 lines
1.4 KiB
Markdown
# Corso documentation
|
|
|
|
Corso documentation uses [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
|
|
[Mermaid](https://mermaid-js.github.io/mermaid/) provides support for native diagrams in Markdown.
|
|
|
|
## Requirements
|
|
|
|
Developing documentation for Corso requires the following tools on your machine:
|
|
|
|
- `make`
|
|
- Docker
|
|
|
|
## Installation
|
|
|
|
```bash
|
|
make buildimage
|
|
```
|
|
|
|
## Live documentation development
|
|
|
|
```bash
|
|
make dev
|
|
```
|
|
|
|
This command starts a local development server within the Docker container and will expose docs at [http://localhost:3000](http://localhost:3000).
|
|
|
|
## Building static documentation
|
|
|
|
```bash
|
|
make build
|
|
```
|
|
|
|
This command generates static content into the `build` directory for integration with any static contents hosting service.
|
|
|
|
## Style and linting
|
|
|
|
```bash
|
|
# Lint all docs
|
|
make dockercheck
|
|
# Lint specific files and/or folders
|
|
make dockercheck VALE_TARGET="README.md docs/concepts"
|
|
```
|
|
|
|
This command will lint all Markdown files and check them for style issues using the Docker container
|
|
|
|
```bash
|
|
make check
|
|
```
|
|
|
|
Same as `make dockercheck` but runs locally. Requires `vale` to be installed.
|
|
|
|
## Documentation platform development
|
|
|
|
```bash
|
|
make shell
|
|
```
|
|
|
|
Use this command to interactively (and temporarily!) change the contents or
|
|
configuration of the live documentation container image (for example, when
|
|
experimenting with new plugins).
|