Skip to content

API docs and tutorials on how to use ImagesSharp and related projects.

Notifications You must be signed in to change notification settings

RodneyNeilMorris/docs

 
 

Repository files navigation

SixLabors API docs site

Prerequisites

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

Make it work

How to update

To pull in the latest source of a project you have to navigate into the ext folder and checkout the required revision (by default these should always be pointing to the latest tagged full release)

How do I build the latest docs

run build.cmd/build.ps1 from the command line. This will checkout that latest tagged commits for each of the repositories and regenerates 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

To make changes make sure you rebuild (run build.cmd) before committing. TODO: automate this as a build step.

About

API docs and tutorials on how to use ImagesSharp and related projects.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Liquid 41.0%
  • CSS 39.2%
  • JavaScript 10.6%
  • PowerShell 5.0%
  • Batchfile 4.2%