420420
421421
422422
423- < div class ="md-sidebar md-sidebar--primary " data-md-component ="sidebar " data-md-type ="navigation " >
423+
424+
425+ < div class ="md-sidebar md-sidebar--primary " data-md-component ="sidebar " data-md-type ="navigation " hidden >
424426 < div class ="md-sidebar__scrollwrap ">
425427 < div class ="md-sidebar__inner ">
426428
699701 < input class ="md-nav__toggle md-toggle " type ="checkbox " id ="__toc ">
700702
701703
702-
703-
704704
705705 < label class ="md-nav__link md-nav__link--active " for ="__toc ">
706706
743743
744744
745745
746-
747-
748746
749747 < label class ="md-nav__title " for ="__toc ">
750748 < span class ="md-nav__icon md-icon "> </ span >
753751 < ul class ="md-nav__list " data-md-component ="toc " data-md-scrollfix >
754752
755753 < li class ="md-nav__item ">
756- < a href ="#_2 " class ="md-nav__link ">
754+ < a href ="#_1 " class ="md-nav__link ">
757755 < span class ="md-ellipsis ">
758756
759757 贡献方式
765763 < ul class ="md-nav__list ">
766764
767765 < li class ="md-nav__item ">
768- < a href ="#_3 " class ="md-nav__link ">
766+ < a href ="#_2 " class ="md-nav__link ">
769767 < span class ="md-ellipsis ">
770768
771769 反馈问题与建议
792790</ li >
793791
794792 < li class ="md-nav__item ">
795- < a href ="#_4 " class ="md-nav__link ">
793+ < a href ="#_3 " class ="md-nav__link ">
796794 < span class ="md-ellipsis ">
797795
798796 开发环境
804802 < ul class ="md-nav__list ">
805803
806804 < li class ="md-nav__item ">
807- < a href ="#_5 " class ="md-nav__link ">
805+ < a href ="#_4 " class ="md-nav__link ">
808806 < span class ="md-ellipsis ">
809807
810808 环境准备
815813</ li >
816814
817815 < li class ="md-nav__item ">
818- < a href ="#_6 " class ="md-nav__link ">
816+ < a href ="#_5 " class ="md-nav__link ">
819817 < span class ="md-ellipsis ">
820818
821819 代码规范
826824</ li >
827825
828826 < li class ="md-nav__item ">
829- < a href ="#_7 " class ="md-nav__link ">
827+ < a href ="#_6 " class ="md-nav__link ">
830828 < span class ="md-ellipsis ">
831829
832830 文档本地预览
842840</ li >
843841
844842 < li class ="md-nav__item ">
845- < a href ="#_8 " class ="md-nav__link ">
843+ < a href ="#_7 " class ="md-nav__link ">
846844 < span class ="md-ellipsis ">
847845
848846 其他说明
937935
938936
939937
940- < div class ="md-sidebar md-sidebar--secondary " data-md-component ="sidebar " data-md-type ="toc " >
938+
939+
940+ < div class ="md-sidebar md-sidebar--secondary " data-md-component ="sidebar " data-md-type ="toc " hidden >
941941 < div class ="md-sidebar__scrollwrap ">
942942 < div class ="md-sidebar__inner ">
943943
946946
947947
948948
949-
950-
951949
952950 < label class ="md-nav__title " for ="__toc ">
953951 < span class ="md-nav__icon md-icon "> </ span >
956954 < ul class ="md-nav__list " data-md-component ="toc " data-md-scrollfix >
957955
958956 < li class ="md-nav__item ">
959- < a href ="#_2 " class ="md-nav__link ">
957+ < a href ="#_1 " class ="md-nav__link ">
960958 < span class ="md-ellipsis ">
961959
962960 贡献方式
968966 < ul class ="md-nav__list ">
969967
970968 < li class ="md-nav__item ">
971- < a href ="#_3 " class ="md-nav__link ">
969+ < a href ="#_2 " class ="md-nav__link ">
972970 < span class ="md-ellipsis ">
973971
974972 反馈问题与建议
995993</ li >
996994
997995 < li class ="md-nav__item ">
998- < a href ="#_4 " class ="md-nav__link ">
996+ < a href ="#_3 " class ="md-nav__link ">
999997 < span class ="md-ellipsis ">
1000998
1001999 开发环境
10071005 < ul class ="md-nav__list ">
10081006
10091007 < li class ="md-nav__item ">
1010- < a href ="#_5 " class ="md-nav__link ">
1008+ < a href ="#_4 " class ="md-nav__link ">
10111009 < span class ="md-ellipsis ">
10121010
10131011 环境准备
10181016</ li >
10191017
10201018 < li class ="md-nav__item ">
1021- < a href ="#_6 " class ="md-nav__link ">
1019+ < a href ="#_5 " class ="md-nav__link ">
10221020 < span class ="md-ellipsis ">
10231021
10241022 代码规范
10291027</ li >
10301028
10311029 < li class ="md-nav__item ">
1032- < a href ="#_7 " class ="md-nav__link ">
1030+ < a href ="#_6 " class ="md-nav__link ">
10331031 < span class ="md-ellipsis ">
10341032
10351033 文档本地预览
10451043</ li >
10461044
10471045 < li class ="md-nav__item ">
1048- < a href ="#_8 " class ="md-nav__link ">
1046+ < a href ="#_7 " class ="md-nav__link ">
10491047 < span class ="md-ellipsis ">
10501048
10511049 其他说明
10921090
10931091<!-- Tags -->
10941092
1093+
1094+
10951095
10961096
10971097<!-- Actions -->
11181118 page title (or respectively site name) is used as the main headline.
11191119-->
11201120
1121+ < h1 > 贡献指南</ h1 >
1122+
11211123
11221124
11231125
11241126<!-- Page content -->
1125- < h1 id ="_1 "> 贡献指南< a class ="headerlink " href ="#_1 " title ="Permanent link "> ¶</ a > </ h1 >
11261127< p > 感谢你对 Rapid Layout 的关注与贡献!欢迎通过以下方式参与项目。</ p >
1127- < h2 id ="_2 "> 贡献方式< a class ="headerlink " href ="#_2 " title ="Permanent link "> ¶</ a > </ h2 >
1128- < h3 id ="_3 "> 反馈问题与建议< a class ="headerlink " href ="#_3 " title ="Permanent link "> ¶</ a > </ h3 >
1128+ < h2 id ="_1 "> 贡献方式< a class ="headerlink " href ="#_1 " title ="Permanent link "> ¶</ a > </ h2 >
1129+ < h3 id ="_2 "> 反馈问题与建议< a class ="headerlink " href ="#_2 " title ="Permanent link "> ¶</ a > </ h3 >
11291130< ul >
11301131< li > < strong > Bug 反馈</ strong > :在 < a href ="https://github.com/RapidAI/RapidLayout/issues "> Issues</ a > 中提交 Bug 报告,请尽量包含复现步骤、环境信息与报错信息。</ li >
11311132< li > < strong > 功能建议</ strong > :在 Issues 中使用 Feature Request 模板描述你的需求或使用场景。</ li >
@@ -1139,26 +1140,31 @@ <h3 id="pull-request">提交代码(Pull Request)<a class="headerlink" href="
11391140< li > < strong > 提交 PR</ strong > :将分支推送到你的 Fork,在 < a href ="https://github.com/RapidAI/RapidLayout "> RapidLayout</ a > 仓库中发起 Pull Request,并简要说明改动内容与原因。</ li >
11401141</ ol >
11411142< p > 我们会尽快 Review,必要时会与你讨论修改建议。</ p >
1142- < h2 id ="_4 "> 开发环境< a class ="headerlink " href ="#_4 " title ="Permanent link "> ¶</ a > </ h2 >
1143- < h3 id ="_5 "> 环境准备< a class ="headerlink " href ="#_5 " title ="Permanent link "> ¶</ a > </ h3 >
1144- < div class ="language-bash highlight "> < pre > < span > </ span > < code > < span id ="__span-0-1 "> < a id ="__codelineno-0-1 " name ="__codelineno-0-1 " href ="#__codelineno-0-1 "> </ a > git< span class ="w "> </ span > clone< span class ="w "> </ span > https://github.com/RapidAI/RapidLayout.git
1145- </ span > < span id ="__span-0-2 "> < a id ="__codelineno-0-2 " name ="__codelineno-0-2 " href ="#__codelineno-0-2 "> </ a > < span class ="nb "> cd</ span > < span class ="w "> </ span > RapidLayout
1146- </ span > < span id ="__span-0-3 "> < a id ="__codelineno-0-3 " name ="__codelineno-0-3 " href ="#__codelineno-0-3 "> </ a > pip< span class ="w "> </ span > install< span class ="w "> </ span > -r< span class ="w "> </ span > requirements.txt
1147- </ span > < span id ="__span-0-4 "> < a id ="__codelineno-0-4 " name ="__codelineno-0-4 " href ="#__codelineno-0-4 "> </ a > pip< span class ="w "> </ span > install< span class ="w "> </ span > -e< span class ="w "> </ span > .
1148- </ span > </ code > </ pre > </ div >
1149- < h3 id ="_6 "> 代码规范< a class ="headerlink " href ="#_6 " title ="Permanent link "> ¶</ a > </ h3 >
1143+ < h2 id ="_3 "> 开发环境< a class ="headerlink " href ="#_3 " title ="Permanent link "> ¶</ a > </ h2 >
1144+ < h3 id ="_4 "> 环境准备< a class ="headerlink " href ="#_4 " title ="Permanent link "> ¶</ a > </ h3 >
1145+ < div class ="language-bash highlight "> < table class ="highlighttable "> < tr > < td class ="linenos "> < div class ="linenodiv "> < pre > < span > </ span > < span class ="normal "> < a href ="#__codelineno-0-1 "> 1</ a > </ span >
1146+ < span class ="normal "> < a href ="#__codelineno-0-2 "> 2</ a > </ span >
1147+ < span class ="normal "> < a href ="#__codelineno-0-3 "> 3</ a > </ span >
1148+ < span class ="normal "> < a href ="#__codelineno-0-4 "> 4</ a > </ span > </ pre > </ div > </ td > < td class ="code "> < div > < pre > < span > </ span > < code > < span id ="__span-0-1 "> < a id ="__codelineno-0-1 " name ="__codelineno-0-1 "> </ a > git< span class ="w "> </ span > clone< span class ="w "> </ span > https://github.com/RapidAI/RapidLayout.git
1149+ </ span > < span id ="__span-0-2 "> < a id ="__codelineno-0-2 " name ="__codelineno-0-2 "> </ a > < span class ="nb "> cd</ span > < span class ="w "> </ span > RapidLayout
1150+ </ span > < span id ="__span-0-3 "> < a id ="__codelineno-0-3 " name ="__codelineno-0-3 "> </ a > pip< span class ="w "> </ span > install< span class ="w "> </ span > -r< span class ="w "> </ span > requirements.txt
1151+ </ span > < span id ="__span-0-4 "> < a id ="__codelineno-0-4 " name ="__codelineno-0-4 "> </ a > pip< span class ="w "> </ span > install< span class ="w "> </ span > -e< span class ="w "> </ span > .
1152+ </ span > </ code > </ pre > </ div > </ td > </ tr > </ table > </ div >
1153+ < h3 id ="_5 "> 代码规范< a class ="headerlink " href ="#_5 " title ="Permanent link "> ¶</ a > </ h3 >
11501154< p > 项目使用 < a href ="https://github.com/psf/black "> black</ a > 做代码格式化,并配合 pre-commit 做提交前检查。建议在本地安装 pre-commit:</ p >
1151- < div class ="language-bash highlight "> < pre > < span > </ span > < code > < span id ="__span-1-1 "> < a id ="__codelineno-1-1 " name ="__codelineno-1-1 " href ="#__codelineno-1-1 "> </ a > pip< span class ="w "> </ span > install< span class ="w "> </ span > pre-commit
1152- </ span > < span id ="__span-1-2 "> < a id ="__codelineno-1-2 " name ="__codelineno-1-2 " href ="#__codelineno-1-2 "> </ a > pre-commit< span class ="w "> </ span > install
1153- </ span > </ code > </ pre > </ div >
1155+ < div class ="language-bash highlight "> < table class ="highlighttable "> < tr > < td class ="linenos "> < div class ="linenodiv "> < pre > < span > </ span > < span class ="normal "> < a href ="#__codelineno-1-1 "> 1</ a > </ span >
1156+ < span class ="normal "> < a href ="#__codelineno-1-2 "> 2</ a > </ span > </ pre > </ div > </ td > < td class ="code "> < div > < pre > < span > </ span > < code > < span id ="__span-1-1 "> < a id ="__codelineno-1-1 " name ="__codelineno-1-1 "> </ a > pip< span class ="w "> </ span > install< span class ="w "> </ span > pre-commit
1157+ </ span > < span id ="__span-1-2 "> < a id ="__codelineno-1-2 " name ="__codelineno-1-2 "> </ a > pre-commit< span class ="w "> </ span > install
1158+ </ span > </ code > </ pre > </ div > </ td > </ tr > </ table > </ div >
11541159< p > 提交前会自动执行 < code > autoflake</ code > (清理未使用导入与变量)和 < code > black</ code > 格式化,请确保修改后的代码通过上述检查。</ p >
1155- < h3 id ="_7 "> 文档本地预览< a class ="headerlink " href ="#_7 " title ="Permanent link "> ¶</ a > </ h3 >
1160+ < h3 id ="_6 "> 文档本地预览< a class ="headerlink " href ="#_6 " title ="Permanent link "> ¶</ a > </ h3 >
11561161< p > 修改 < code > docs/</ code > 下内容后,可使用 MkDocs 本地预览:</ p >
1157- < div class ="language-bash highlight "> < pre > < span > </ span > < code > < span id ="__span-2-1 "> < a id ="__codelineno-2-1 " name ="__codelineno-2-1 " href ="#__codelineno-2-1 "> </ a > pip< span class ="w "> </ span > install< span class ="w "> </ span > -r< span class ="w "> </ span > requirements.txt
1158- </ span > < span id ="__span-2-2 "> < a id ="__codelineno-2-2 " name ="__codelineno-2-2 " href ="#__codelineno-2-2 "> </ a > mkdocs< span class ="w "> </ span > serve
1159- </ span > </ code > </ pre > </ div >
1162+ < div class ="language-bash highlight "> < table class ="highlighttable "> < tr > < td class ="linenos "> < div class ="linenodiv "> < pre > < span > </ span > < span class ="normal "> < a href ="#__codelineno-2-1 "> 1</ a > </ span >
1163+ < span class ="normal "> < a href ="#__codelineno-2-2 "> 2</ a > </ span > </ pre > </ div > </ td > < td class ="code "> < div > < pre > < span > </ span > < code > < span id ="__span-2-1 "> < a id ="__codelineno-2-1 " name ="__codelineno-2-1 "> </ a > pip< span class ="w "> </ span > install< span class ="w "> </ span > -r< span class ="w "> </ span > requirements.txt
1164+ </ span > < span id ="__span-2-2 "> < a id ="__codelineno-2-2 " name ="__codelineno-2-2 "> </ a > mkdocs< span class ="w "> </ span > serve
1165+ </ span > </ code > </ pre > </ div > </ td > </ tr > </ table > </ div >
11601166< p > 在浏览器中打开提示的地址(一般为 < code > http://127.0.0.1:8000</ code > )即可查看效果。</ p >
1161- < h2 id ="_8 "> 其他说明< a class ="headerlink " href ="#_8 " title ="Permanent link "> ¶</ a > </ h2 >
1167+ < h2 id ="_7 "> 其他说明< a class ="headerlink " href ="#_7 " title ="Permanent link "> ¶</ a > </ h2 >
11621168< ul >
11631169< li > 提交 Issue 或 PR 时,请使用清晰、简洁的标题与描述,便于维护者处理。</ li >
11641170< li > 若你希望参与长期维护或较大功能开发,欢迎在 Issue 中说明,我们会与你沟通协作方式。</ li >
@@ -1188,7 +1194,7 @@ <h2 id="_8">其他说明<a class="headerlink" href="#_8" title="Permanent link">
11881194 < span class ="md-icon " title ="最后更新 ">
11891195 < svg xmlns ="http://www.w3.org/2000/svg " viewBox ="0 0 24 24 "> < path d ="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1zM12.5 7v5.2l4 2.4-1 1L11 13V7zM11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2z "/> </ svg >
11901196 </ span >
1191- < span class ="git-revision-date-localized-plugin git-revision-date-localized-plugin-iso_datetime " title ="2026年2月7日 11:11:53 CST "> 2026-02-07 11:11:53 </ span >
1197+ < span class ="git-revision-date-localized-plugin git-revision-date-localized-plugin-iso_datetime " title ="2026年2月7日 11:45:29 CST "> 2026-02-07 11:45:29 </ span >
11921198 </ span >
11931199
11941200
@@ -1233,10 +1239,67 @@ <h2 id="_8">其他说明<a class="headerlink" href="#_8" title="Permanent link">
12331239<!-- Was this page helpful? -->
12341240
12351241
1242+
1243+
12361244
12371245
12381246<!-- Comment system -->
12391247
1248+ < h2 id ="__comments "> 评论</ h2 >
1249+ <!-- Insert generated snippet here -->
1250+
1251+ < script src ="https://giscus.app/client.js "
1252+ data-repo ="RapidAI/RapidLayout "
1253+ data-repo-id ="R_kgDOMLOtcQ "
1254+ data-category ="General "
1255+ data-category-id ="DIC_kwDOMLOtcc4CgMBG "
1256+ data-mapping ="url "
1257+ data-strict ="0 "
1258+ data-reactions-enabled ="1 "
1259+ data-emit-metadata ="0 "
1260+ data-input-position ="top "
1261+ data-theme ="https://cdn.jsdelivr.net/gh/L33Z22L11/giscus-theme/lxgw-wenkai.css "
1262+ data-lang ="zh-CN "
1263+ data-loading ="lazy " crossorigin ="anonymous " async >
1264+ </ script >
1265+
1266+
1267+ <!-- Synchronize Giscus theme with palette -->
1268+ < script >
1269+ var giscus = document . querySelector ( "script[src*=giscus]" )
1270+
1271+ // Set palette on initial load
1272+ var palette = __md_get ( "__palette" )
1273+ if ( palette && typeof palette . color === "object" ) {
1274+ var theme = palette . color . scheme === "slate"
1275+ ? "transparent_dark"
1276+ : "light"
1277+
1278+ // Instruct Giscus to set theme
1279+ giscus . setAttribute ( "data-theme" , theme )
1280+ }
1281+
1282+ // Register event handlers after documented loaded
1283+ document . addEventListener ( "DOMContentLoaded" , function ( ) {
1284+ var ref = document . querySelector ( "[data-md-component=palette]" )
1285+ ref . addEventListener ( "change" , function ( ) {
1286+ var palette = __md_get ( "__palette" )
1287+ if ( palette && typeof palette . color === "object" ) {
1288+ var theme = palette . color . scheme === "slate"
1289+ ? "transparent_dark"
1290+ : "light"
1291+
1292+ // Instruct Giscus to change theme
1293+ var frame = document . querySelector ( ".giscus-frame" )
1294+ frame . contentWindow . postMessage (
1295+ { giscus : { setConfig : { theme } } } ,
1296+ "https://giscus.app"
1297+ )
1298+ }
1299+ } )
1300+ } )
1301+ </ script >
1302+
12401303
12411304 </ article >
12421305 </ div >
@@ -1259,6 +1322,8 @@ <h2 id="_8">其他说明<a class="headerlink" href="#_8" title="Permanent link">
12591322
12601323
12611324
1325+
1326+
12621327 < nav class ="md-footer__inner md-grid " aria-label ="页脚 " >
12631328
12641329
0 commit comments