d-edge / d-edge/Cardizer

Generate a HTML doc and host it online

Open
#67 0 comments 0 reactions 0 assignees View on GitHub
documentation hacktoberfest hacktoberfest-accepted
Dominant language
F#
Stars
28
Forks
10
PR merge metrics
No merged PRs in 30d

Description

Hi!

Let's use [docfx](https://dotnet.github.io/docfx/) to generate a static documentation for Cardizer.

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

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.