diff options
author | Nate Sesti <sestinj@gmail.com> | 2023-09-12 00:59:20 -0700 |
---|---|---|
committer | Nate Sesti <sestinj@gmail.com> | 2023-09-12 00:59:20 -0700 |
commit | 331b2adcb6f8d962e4ed19292fd2ab5838ba479e (patch) | |
tree | 055989d31f18f18971d9f8e3e5764b59ed0c2be5 /docs/src | |
parent | e9afb41bed9a723876cf1cf95d636b2ea498a6b3 (diff) | |
download | sncontinue-331b2adcb6f8d962e4ed19292fd2ab5838ba479e.tar.gz sncontinue-331b2adcb6f8d962e4ed19292fd2ab5838ba479e.tar.bz2 sncontinue-331b2adcb6f8d962e4ed19292fd2ab5838ba479e.zip |
docs: :memo: major docs improvements
Diffstat (limited to 'docs/src')
-rw-r--r-- | docs/src/components/ClassPropertyRef.tsx | 34 | ||||
-rw-r--r-- | docs/src/css/custom.css | 16 |
2 files changed, 39 insertions, 11 deletions
diff --git a/docs/src/components/ClassPropertyRef.tsx b/docs/src/components/ClassPropertyRef.tsx index 46664c4c..7246663b 100644 --- a/docs/src/components/ClassPropertyRef.tsx +++ b/docs/src/components/ClassPropertyRef.tsx @@ -4,8 +4,14 @@ interface ClassPropertyRefProps { name: string; details: string; required: boolean; + default: string; } +const PYTHON_TYPES = { + string: "str", + integer: "int", +}; + export default function ClassPropertyRef(props: ClassPropertyRefProps) { const details = JSON.parse(props.details); @@ -15,10 +21,32 @@ export default function ClassPropertyRef(props: ClassPropertyRefProps) { <h4 style={{ display: "inline-block", marginRight: "10px" }}> {props.name} </h4> - <span style={{ color: "red", fontSize: "11px", marginRight: "4px" }}> - {props.required && "REQUIRED"} + {props.required && ( + <span + style={{ + color: "red", + fontSize: "11px", + marginRight: "4px", + borderRadius: "4px", + border: "1px solid red", + padding: "1px 2px", + }} + > + REQUIRED + </span> + )} + <span> + {details.type && `(${PYTHON_TYPES[details.type] || details.type})`} </span> - <span>{details.type && `(${details.type})`}</span> + + {props.default && ( + <span> + {" "} + = {details.type === "string" && '"'} + {props.default} + {details.type === "string" && '"'} + </span> + )} </div> <p>{details.description}</p> </> diff --git a/docs/src/css/custom.css b/docs/src/css/custom.css index 794febaf..3a7178dd 100644 --- a/docs/src/css/custom.css +++ b/docs/src/css/custom.css @@ -18,13 +18,13 @@ } /* For readability concerns, you should choose a lighter palette in dark mode. */ -[data-theme='dark'] { - --ifm-color-primary: #be1b55ff; - --ifm-color-primary-dark: #be1b55ff; - --ifm-color-primary-darker: #be1b55ff; - --ifm-color-primary-darkest: #be1b55ff; - --ifm-color-primary-light: #be1b55ff; - --ifm-color-primary-lighter: #be1b55ff; - --ifm-color-primary-lightest: #be1b55ff; +[data-theme="dark"] { + --ifm-color-primary: #59bc89ff; + --ifm-color-primary-dark: #59bc89ff; + --ifm-color-primary-darker: #59bc89ff; + --ifm-color-primary-darkest: #59bc89ff; + --ifm-color-primary-light: #59bc89ff; + --ifm-color-primary-lighter: #59bc89ff; + --ifm-color-primary-lightest: #59bc89ff; --docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.3); } |