JayArrowz / JayArrowz/SignalRHubDocs

Description Support markdown like OpenAPI

Open
#1 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
HTML
Stars
1
Forks
0
PR merge metrics
No merged PRs in 30d

Description

I like your package; I wish the description supported Markdown syntax, similar to the API documentation generated by tools like Swagger or Scalar.

In my code:
Image

options.description of package
Image

I want to apply markdown like Swagger
Image

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No source file or test is named. Start at the options.description entry point and the generated documentation interface described in the repository summary; identify how descriptions are currently displayed. Done means Markdown in a description renders like the Swagger or Scalar examples shown in the issue, with existing plain-text descriptions still working.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp, html
Domain
documentation, frontend
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
52/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.