https://github.com/sixlabors/docs
API docs and tutorials on how to use ImagesSharp and related projects.
https://github.com/sixlabors/docs
docs-site
Last synced: 4 months ago
JSON representation
API docs and tutorials on how to use ImagesSharp and related projects.
- Host: GitHub
- URL: https://github.com/sixlabors/docs
- Owner: SixLabors
- Created: 2018-01-04T19:37:08.000Z (over 8 years ago)
- Default Branch: main
- Last Pushed: 2026-02-03T21:30:15.000Z (4 months ago)
- Last Synced: 2026-02-04T10:37:04.509Z (4 months ago)
- Topics: docs-site
- Language: CSS
- Homepage: https://docs.sixlabors.com
- Size: 13 MB
- Stars: 12
- Watchers: 4
- Forks: 38
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# SixLabors API docs site
## Prerequisites
latest [docfx](https://dotnet.github.io/docfx/) version needs to be installed. *[This can be installed via chocolatey](https://dotnet.github.io/docfx/tutorial/docfx_getting_started.html#2-use-docfx-as-a-command-line-tool)*
## 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](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.