Skip to content

fix: 修复对象默认值格式展示换行，导致表格展示奇怪 #20

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.

Sign up for GitHub

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

fix: 修复对象默认值格式展示换行，导致表格展示奇怪 #20

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e0ec5ef
fix: 修复对象默认值格式展示换行，导致表格展示奇怪
Triumph-light Jul 19, 2025
fe79d1f
feat: 完善方法，优化展示
Triumph-light Jul 21, 2025
12a48c1
feat: 支持嵌套对象展示
Triumph-light Jul 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions packages/website-build/src/compiler/compile-src-code-md.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,29 @@ import { parser } from '@mpxjs/vuese-parser'
import { Render } from '@mpxjs/vuese-markdown-render'
import { renderOptions } from '../common/options.js'

/**
* 将字符串的对象转为可读的markdown格式
* @param str
* @returns
*/
function convertObjectStringToMarkdownHtml(str) {
Copy link
Collaborator

@QiuShuiBai QiuShuiBai Jul 24, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

如果某个属性也是对象的话，缩进会有缺陷。可以看看优化下

a = {
    b: {
        c: 1
    }
    d: 2
}

if (!str) return
return (
'<pre><code>' +
str
.split('\n')
.map((line, idx) => {
line = line.replace(/\s+/g, '').replace(/</g, '&lt;').replace(/>/g, '&gt;')
if (idx !== 0 && idx !== str.split('\n').length - 1) {
line = ' ' + line
}
return line
}) // 防止HTML标签注入
.join('<br>') +
'</code></pre>'
)
}

/**
* 解析 cube-ui src 文件夹下的组件，生成md文档
*
Expand Down Expand Up @@ -44,6 +67,9 @@ const genSrcCodeMd = function (srcDir: string, component: string, fnMixins) {
item.type = item.type.replace(/\n/g, '<br>')
item.type = item.type.replace(new RegExp(optionalMark, 'g'), '?')
})
text.props?.forEach(item => {
item.default = convertObjectStringToMarkdownHtml(item.default)
})
const render = new Render(text, Object.assign({
name: component
} as any, renderOptions))
Expand Down