clamoriniere / crd-to-markdown Goto Github PK
View Code? Open in Web Editor NEWutil to generate a markdown file from a Kubernetes CRD go struct definition
License: Apache License 2.0
util to generate a markdown file from a Kubernetes CRD go struct definition
License: Apache License 2.0
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?
crd-to-markdown v0.0.3.
// sentence 1.
//
// sentence 2.
//
// - item 1
// - item 2
//
// sentence 3.
I want to output blank lines and bullets as is.
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.
A declarative, efficient, and flexible JavaScript library for building user interfaces.
๐ Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. ๐๐๐
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google โค๏ธ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.