What is Refine?【免费下载链接】refineA React Framework for building internal tools, admin panels, dashboards B2B apps with unmatched flexibility.项目地址: https://gitcode.com/GitHub_Trending/re/refineHow to use Refine?How to customize Refine?你需要在文章顶部添加如下带锚点链接的目录列表锚点由小写标题、空格替换为连字符生成 markdown - [What is Refine?](#what-is-refine) - [How to use Refine?](#how-to-use-refine) - [How to customize Refine?](#how-to-customize-refine)发布后这段目录会以带链接的列表形式呈现在文章开头帮助读者快速定位章节。代码块规范代码是技术文章的核心载体Refine 博客对代码块有一套明确的书写约定核心原则是像第一次阅读这篇文章的初学者一样一步步解释主题内容。代码块内容保持最小化代码块内容尽可能精简只保留与当前讲解主题直接相关的代码。只有当组件的 import、函数定义等确实是代码正常运行所必需时才把它们放进代码块不要展示本节尚未解释或未实现的代码。简单来说只贴必需的代码块。文件路径与代码块语法无论代码是用 TypeScript 还是 JavaScript 编写的代码块的语言标识一律使用tsx这只是为了获得正确的语法着色。使用title属性展示代码块对应的文件名推荐为所有代码块都加上title让读者更容易理解项目文件结构。例如function App() { return ( Refine routerProvider{routerProvider} dataProvider{dataProvider(https://api.fake-rest.refine.dev)} / ); }发布后的博客文章中代码块会渲染出带文件名标题栏的样式。语法高亮突出新增代码当你在已有代码块的基础上新增代码时应该使用语法高亮技术让读者一眼看出哪些是新增内容。高亮单行使用//highlight-next-line注释标记下一行。例如给Refine /组件添加resources属性function App() { return ( Refine routerProvider{routerProvider} dataProvider{dataProvider(https://api.fake-rest.refine.dev)} //highlight-next-line resources{[{ name: posts, list: Posts }]} / ); }高亮多行使用//highlight-start与//highlight-end包裹需要高亮的区间function App() { return ( Refine routerProvider{routerProvider} dataProvider{dataProvider(https://api.fake-rest.refine.dev)} //highlight-start resources{[ { name: posts, list: Posts } { name: users, list: Users }]} //highlight-end / ); }从源码看这套高亮注释并非 Docusaurus 的默认行为而是在 documentation/docusaurus.config.js 的themeConfig.prism.magicComments中显式注册的highlight-next-line映射到高亮行样式highlight-start/highlight-end映射到高亮区块样式。该配置还额外注册了hide-next-line/hide-start/hide-end隐藏代码行以及added-line、removed-line标记新增/删除行等魔法注释供进阶场景使用。因此投稿时正确使用这些注释就能在发布的页面上获得一致的高亮效果。截图与图片规范如果你在构建示例应用建议添加截图或图片来展示运行结果。具体要求如下精心设计示例应用的输出效果使其看起来酷炫且易于理解——截图本身就是文章质量的一部分。如果使用 GIF 动图请在加入文章前优化 GIF 体积可使用 ezgif 之类的在线工具压缩。配图应与文章讲解的功能直接相关界面效果、架构流程、运行结果等避免使用与主题无关的装饰性图片。深入理解博客的构建与校验机制为了让投稿规范落地仓库在文档站层面做了配套实现理解这些机制有助于你一次通过投稿。博客插件与路由生成博客功能由自定义插件驱动。在 documentation/docusaurus.config.js 中./plugins/blog-plugin.js被注册为博客内容插件配置了博客标题、描述、routeBasePath: /blog、每页文章数postsPerPage: 12以及 RSS feed 选项。插件的实现见 documentation/plugins/blog-plugin.js它基于docusaurus/plugin-content-blog扩展负责生成博客列表页、标签页、分类页、作者页等路由并在构建时执行分类/标签校验validateCategoryAndTags与站点地图lastmod注入。这意味着分类和标签写错会直接导致构建失败而不只是显示层面的问题。投稿前请对照ALLOWED_CATEGORIES与ALLOWED_TAGS白名单核对 frontmatter。本地预览博客你可以在本地运行博客站点进行预览。文档站的脚本配置见 documentation/package.json# 仅启动博客禁用文档与版本化加快启动速度 pnpm dev:blog # 或直接启动完整文档站 pnpm dev【免费下载链接】refineA React Framework for building internal tools, admin panels, dashboards B2B apps with unmatched flexibility.项目地址: https://gitcode.com/GitHub_Trending/re/refine创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考 What is Refine?
What is Refine?【免费下载链接】refineA React Framework for building internal tools, admin panels, dashboards B2B apps with unmatched flexibility.项目地址: https://gitcode.com/GitHub_Trending/re/refineHow to use Refine?How to customize Refine?你需要在文章顶部添加如下带锚点链接的目录列表锚点由小写标题、空格替换为连字符生成 markdown - [What is Refine?](#what-is-refine) - [How to use Refine?](#how-to-use-refine) - [How to customize Refine?](#how-to-customize-refine)发布后这段目录会以带链接的列表形式呈现在文章开头帮助读者快速定位章节。代码块规范代码是技术文章的核心载体Refine 博客对代码块有一套明确的书写约定核心原则是像第一次阅读这篇文章的初学者一样一步步解释主题内容。代码块内容保持最小化代码块内容尽可能精简只保留与当前讲解主题直接相关的代码。只有当组件的 import、函数定义等确实是代码正常运行所必需时才把它们放进代码块不要展示本节尚未解释或未实现的代码。简单来说只贴必需的代码块。文件路径与代码块语法无论代码是用 TypeScript 还是 JavaScript 编写的代码块的语言标识一律使用tsx这只是为了获得正确的语法着色。使用title属性展示代码块对应的文件名推荐为所有代码块都加上title让读者更容易理解项目文件结构。例如function App() { return ( Refine routerProvider{routerProvider} dataProvider{dataProvider(https://api.fake-rest.refine.dev)} / ); }发布后的博客文章中代码块会渲染出带文件名标题栏的样式。语法高亮突出新增代码当你在已有代码块的基础上新增代码时应该使用语法高亮技术让读者一眼看出哪些是新增内容。高亮单行使用//highlight-next-line注释标记下一行。例如给Refine /组件添加resources属性function App() { return ( Refine routerProvider{routerProvider} dataProvider{dataProvider(https://api.fake-rest.refine.dev)} //highlight-next-line resources{[{ name: posts, list: Posts }]} / ); }高亮多行使用//highlight-start与//highlight-end包裹需要高亮的区间function App() { return ( Refine routerProvider{routerProvider} dataProvider{dataProvider(https://api.fake-rest.refine.dev)} //highlight-start resources{[ { name: posts, list: Posts } { name: users, list: Users }]} //highlight-end / ); }从源码看这套高亮注释并非 Docusaurus 的默认行为而是在 documentation/docusaurus.config.js 的themeConfig.prism.magicComments中显式注册的highlight-next-line映射到高亮行样式highlight-start/highlight-end映射到高亮区块样式。该配置还额外注册了hide-next-line/hide-start/hide-end隐藏代码行以及added-line、removed-line标记新增/删除行等魔法注释供进阶场景使用。因此投稿时正确使用这些注释就能在发布的页面上获得一致的高亮效果。截图与图片规范如果你在构建示例应用建议添加截图或图片来展示运行结果。具体要求如下精心设计示例应用的输出效果使其看起来酷炫且易于理解——截图本身就是文章质量的一部分。如果使用 GIF 动图请在加入文章前优化 GIF 体积可使用 ezgif 之类的在线工具压缩。配图应与文章讲解的功能直接相关界面效果、架构流程、运行结果等避免使用与主题无关的装饰性图片。深入理解博客的构建与校验机制为了让投稿规范落地仓库在文档站层面做了配套实现理解这些机制有助于你一次通过投稿。博客插件与路由生成博客功能由自定义插件驱动。在 documentation/docusaurus.config.js 中./plugins/blog-plugin.js被注册为博客内容插件配置了博客标题、描述、routeBasePath: /blog、每页文章数postsPerPage: 12以及 RSS feed 选项。插件的实现见 documentation/plugins/blog-plugin.js它基于docusaurus/plugin-content-blog扩展负责生成博客列表页、标签页、分类页、作者页等路由并在构建时执行分类/标签校验validateCategoryAndTags与站点地图lastmod注入。这意味着分类和标签写错会直接导致构建失败而不只是显示层面的问题。投稿前请对照ALLOWED_CATEGORIES与ALLOWED_TAGS白名单核对 frontmatter。本地预览博客你可以在本地运行博客站点进行预览。文档站的脚本配置见 documentation/package.json# 仅启动博客禁用文档与版本化加快启动速度 pnpm dev:blog # 或直接启动完整文档站 pnpm dev【免费下载链接】refineA React Framework for building internal tools, admin panels, dashboards B2B apps with unmatched flexibility.项目地址: https://gitcode.com/GitHub_Trending/re/refine创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考