Skip to content

Generate a HTML doc and host it online #25

Open

Description

@aloisdg

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).

Activity

  1. added
    documentationImprovements or additions to documentation
    hacktoberfestHacktoberfest encourages participation in the open source community, which grows bigger every year.
    on Oct 7, 2021
  2. changed the title [-]Generate an HTML doc and host it online[/-] [+]Generate a HTML doc and host it online[/+] on Oct 7, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationhacktoberfestHacktoberfest encourages participation in the open source community, which grows bigger every year.hacktoberfest-accepted

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions