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.

Sign up for GitHub

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

Jump to bottom

Generate a HTML doc and host it online #25

Open
aloisdg opened this issue Oct 7, 2021 · 0 comments
Open

Generate a HTML doc and host it online #25

aloisdg opened this issue Oct 7, 2021 · 0 comments
Labels
documentation Improvements or additions to documentation hacktoberfest Hacktoberfest encourages participation in the open source community, which grows bigger every year. hacktoberfest-accepted

Comments

@aloisdg
Copy link
Member

aloisdg commented Oct 7, 2021

Hi!

Let's use docfx to generate a static documentation for Cardidy.

DocFX is an API documentation generator for .NET, which currently supports C#, VB and F#. It generates API reference documentation from triple-slash comments in your source code. It also allows you to use Markdown files to create additional topics such as tutorials and how-tos, and to customize the generated reference documentation. DocFX builds a static HTML website from your source code and Markdown files.

Then to we could host it on a web server (for example, github.io).
@aloisdg aloisdg added documentation Improvements or additions to documentation hacktoberfest Hacktoberfest encourages participation in the open source community, which grows bigger every year. hacktoberfest-accepted labels Oct 7, 2021
@aloisdg aloisdg changed the title Generate an HTML doc and host it online Generate a HTML doc and host it online Oct 7, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation hacktoberfest Hacktoberfest encourages participation in the open source community, which grows bigger every year. hacktoberfest-accepted
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@aloisdg