Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add docfx docs to GitHub Pages #6

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

georg-jung
Copy link

I guess this is a quite opinionated thing to do, so please feel free to close if you don't like it.

Merging this would add automatic publishing of a generated API reference to GitHub pages. To properly work it would additionally require some GitHub pages setup, e.g. adding a custom domain (having a custom domain is not required though).

I personally think having this kind of API reference available would be helpful to get a quick overview of what SharpIppNext has to offer and how it works. What you get is similar to what can be achieved using Visual Studio's Object Browser or IntelliSense.

To get a first impression how this would look like, you can take a look at a similar docs page I create for one of my projects: https://fastberttokenizer.gjung.com/

Alternatively you could locally execute from repo root of this PR's branch:

dotnet tool install -g docfx
docfx docfx/docfx.json --serve

But I'd also understand if you don't want to take the additional maintenance burden. Thanks for creating a modern printing solution for the .NET ecosystem!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant