clamoriniere / crd-to-markdown Goto Github PK

Hi,
Thank you for developing a handy tool!

I found that this tool does not render the blank lines and bullet points as I expected.
Could you consider revising it?

Version

crd-to-markdown v0.0.3.

Input comment

// sentence 1.
//
// sentence 2.
//
// - item 1
// - item 2
//
// sentence 3.

I want to output blank lines and bullets as is.

Outputed markdown

sentence 1.\n\nsentence 2.\n\n- item 1 - item 2\n\nsentence 3.

The crd-to-markdown convert blank lines to \n\n.
And bullet points don't have a trailing newline.

The code ignores fields that are have a json tag that contains "inline" but this is incorrect. Those fields should simply be added to the current struct. For example

type ClientConfiguration struct {
	metav1.TypeMeta `json:",inline"`
	SubConfig `json:",inline"`
        Foo string `json:"foo"`
}

Only the "foo" field will be included. All the fields of TypeMeta (apiVersion and Kind) and SubConfig are ignored since they are inlined. But they exist in the JSON.