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

Support markdown syntax with HTML output #319

Open
FlorianWolters opened this issue Aug 18, 2017 · 0 comments
Open

Support markdown syntax with HTML output #319

FlorianWolters opened this issue Aug 18, 2017 · 0 comments

Comments

@FlorianWolters
Copy link

I think it would be great if protoc-gen-doc would support basic Markdown syntax for the creation of a HTML documentation.

Example:

Consider the following Protobuf message:

/**
 * The `DoubleDimension2d` message represents a dimension with **two** elements
 * (*width* and *height*) in double precision.
 */
message DoubleDimension2d {
  /**
   * The width of this `DoubleDimension2d` in double precision.
   */
  double width = 1;

  /**
   * The height of this `DoubleDimension2d` in double precision.
   */
  double height = 2;
}

Current Output:


The `DoubleDimension2d` message represents a dimension with **two** elements
(*width* and *height*) in double precision.


Expected Output:


The DoubleDimension2d message represents a dimension with two elements (width and height) in double precision.


Notice that this issue also describes the problem mentioned in my comment to #274 regarding line breaks.

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

No branches or pull requests

1 participant