API docs and tutorials on how to use ImagesSharp and related projects.
Перейти к файлу
James Jackson-South 0179620f77 Fix note. 2024-07-31 22:18:44 +10:00
.github Update refs, add MAUI docs 2024-07-31 22:12:48 +10:00
.vscode
api
articles Fix note. 2024-07-31 22:18:44 +10:00
ext Update refs, add MAUI docs 2024-07-31 22:12:48 +10:00
templates
.gitattributes
.gitignore
.gitmodules
CNAME
README.md
build-ci.cmd
build-ci.ps1
build-dev.cmd
build-dev.ps1
build.cmd
build.ps1 Update refs, add MAUI docs 2024-07-31 22:12:48 +10:00
docfx.json Update refs, add MAUI docs 2024-07-31 22:12:48 +10:00
index.md
serve.cmd
serve.ps1
toc.yml
vale.ini
xrefmap.yml

README.md

SixLabors API docs site

Prerequisites

latest docfx version needs to be installed. This can be installed via chocolatey

Building the docs locally

How do I build the latest tagged docs

run build.cmd/build.ps1 from the command line. This will checkout that latest tagged commits for each of the repositories and regenerate the site in the docs folder.

How do I build the latest nightly docs

run build-dev.cmd/build-dev.ps1 from the command line. This will checkout that latest commits for each of the repositories and regenerate the site in the docs folder.

How to preview

run serve.cmd/serve.ps1 this rebuilds the site but also runs a dev server at http://localhost:8080 so you can preview the current state of the docs.

Updating the docs

Changes are automatically built by the Actions pipeline upon approval.