From 6f6d1512f54707cdc4da808e76b1035eac0ce2c6 Mon Sep 17 00:00:00 2001 From: okxlin Date: Sat, 13 Apr 2024 00:28:00 +0800 Subject: [PATCH] =?UTF-8?q?feat:=E6=B7=BB=E5=8A=A0raneto=E5=88=B0=E5=88=97?= =?UTF-8?q?=E8=A1=A8?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- apps/raneto/README.md | 51 +++++++ apps/raneto/data.yml | 19 +++ apps/raneto/latest/.env.sample | 2 + apps/raneto/latest/data.yml | 10 ++ apps/raneto/latest/data/config/config.js | 170 +++++++++++++++++++++++ apps/raneto/latest/docker-compose.yml | 19 +++ apps/raneto/logo.png | Bin 0 -> 5755 bytes 7 files changed, 271 insertions(+) create mode 100644 apps/raneto/README.md create mode 100644 apps/raneto/data.yml create mode 100644 apps/raneto/latest/.env.sample create mode 100644 apps/raneto/latest/data.yml create mode 100644 apps/raneto/latest/data/config/config.js create mode 100644 apps/raneto/latest/docker-compose.yml create mode 100644 apps/raneto/logo.png diff --git a/apps/raneto/README.md b/apps/raneto/README.md new file mode 100644 index 00000000..8624062f --- /dev/null +++ b/apps/raneto/README.md @@ -0,0 +1,51 @@ +## 账号密码 +> 默认账户1 +- 账号：admin +- 密码：password + +> 默认账户2 +- 账号：admin2 +- 密码：password + +## MD文档 + +需要展示的 `Markdown` 文档，需要放置在应用数据目录下的 `/data/content/pages` 文件夹下。 + +在此文件夹下新建文件夹，则就是网页上的新建分类。 + +## 配置文件 + +> `Raneto` 的配置文件为 `config.js`，在应用数据目录下的 `/data/config` 目录下，编辑`config.js`文件修改设置。 + + +## 注意 + +编辑 `config.js` 文件修改设置。 + +- 站点名称 + +```shel +site_title: 'Raneto Docs', +``` + +- 用户名和密码 +```shell + credentials: [ + { + username: 'admin', + password: 'password', + }, + { + username: 'admin2', + password: 'password', + }, + ], + ``` + +- 支持中文语言 +```shell +locale: 'zh', + + // Support search with extra languages + searchExtraLanguages: ['zh'], +``` \ No newline at end of file diff --git a/apps/raneto/data.yml b/apps/raneto/data.yml new file mode 100644 index 00000000..4c3f4e55 --- /dev/null +++ b/apps/raneto/data.yml @@ -0,0 +1,19 @@ +name: Raneto +tags: + - 实用工具 +title: 一个免费、开放、简单的 Markdown 支持的 Node.js 知识库 +description: 一个免费、开放、简单的 Markdown 支持的 Node.js 知识库 +additionalProperties: + key: raneto + name: Raneto + tags: + - Tool + shortDescZh: 一个免费、开放、简单的 Markdown 支持的 Node.js 知识库 + shortDescEn: A free, open, and simple Markdown supported Node.js knowledge base + type: tool + crossVersionUpdate: true + limit: 0 + recommend: 0 + website: https://raneto.com + github: https://github.com/ryanlelek/Raneto + document: https://docs.raneto.com diff --git a/apps/raneto/latest/.env.sample b/apps/raneto/latest/.env.sample new file mode 100644 index 00000000..1a967b01 --- /dev/null +++ b/apps/raneto/latest/.env.sample @@ -0,0 +1,2 @@ +CONTAINER_NAME="raneto" +PANEL_APP_PORT_HTTP="40216" diff --git a/apps/raneto/latest/data.yml b/apps/raneto/latest/data.yml new file mode 100644 index 00000000..2c83b163 --- /dev/null +++ b/apps/raneto/latest/data.yml @@ -0,0 +1,10 @@ +additionalProperties: + formFields: + - default: 40216 + edit: true + envKey: PANEL_APP_PORT_HTTP + labelEn: Port + labelZh: 端口 + required: true + rule: paramPort + type: number diff --git a/apps/raneto/latest/data/config/config.js b/apps/raneto/latest/data/config/config.js new file mode 100644 index 00000000..6a931b38 --- /dev/null +++ b/apps/raneto/latest/data/config/config.js @@ -0,0 +1,170 @@ +// Modules +var path = require('path'); + +// Which Theme to Use? +// +// Local Directory Example (for development or custom themes) +// var theme_dir = path.join(__dirname, 'themes'); +// var theme_name = 'my-theme-directory'; +// +// Themes from NPM +// use "dist" as the theme name for modules (for now) +var theme_dir = path.join( + __dirname, + '..', + 'node_modules', + '@raneto/theme-default' +); +var theme_name = 'dist'; + +var config = { + // Your site title (format: page_title - site_title) + site_title: 'Raneto Docs', + + // The base URL of your site (can use %base_url% in Markdown files) + // This should be the full path to your Raneto installation: + // example 1: https://raneto.mydomain.com + // example 2: https://www.mydomain.com/raneto + // Do not include a trailing "/" + // Leave this as an empty string to use the default + base_url: '', + nowrap: true, + + // Path Prefix + // If you are running Raneto on a subpath of your domain, add it here + // Leave it blank if you are not sure + // + // Example: if you are running Raneto at http://www.mydomain.com/raneto + // then you would enter '/raneto' below + path_prefix: '', + + // Used for the "Get in touch" page footer link + support_email: '', + + // Footer Text / Copyright + copyright: `Copyright © ${new Date().getFullYear()} - Powered by Raneto`, + + // Excerpt length (used in search) + excerpt_length: 400, + + // The meta value by which to sort pages (value should be an integer) + // If this option is blank pages will be sorted alphabetically + page_sort_meta: 'sort', + + // Should categories be sorted numerically (true) or alphabetically (false) + // If true category folders need to contain a "sort" file with an integer value + category_sort: true, + + // Controls behavior of home page if meta ShowOnHome is not present. If set to true + // all categories or files that do not specify ShowOnHome meta property will be shown + show_on_home_default: true, + + // Theme (see top of file) + theme_dir, + theme_name, + + // Specify the path of your content folder where all your '.md' files are located + // Fix: Cannot be an absolute path + content_dir: path.join(__dirname, '..', 'content', 'pages'), + + // Where is the public directory or document root? + public_dir: path.join(theme_dir, theme_name, 'public'), + + // The base URL of your images folder, + // Relative to config.public_dir + // (can use %image_url% in Markdown files) + image_url: '/images', + + // Add your analytics tracking code (including script tags) + analytics: '', + + // Set to true to enable the web editor + allow_editing: true, + + // Set to true to enable HTTP Basic Authentication + authentication: true, + + // If editing is enabled, set this to true to only authenticate for editing, not for viewing + authentication_for_edit: true, + + // If authentication is enabled, set this to true to enable authentication for reading too + authentication_for_read: false, + + // Google OAuth + googleoauth: false, + google_group_restriction: { + enabled: false, + api_key: 'GOOGLE_API_KEY', + group_name: 'GOOGLE_GROUP_NAME', + }, + oauth2: { + client_id: 'GOOGLE_CLIENT_ID', + client_secret: 'GOOGLE_CLIENT_SECRET', + callback: 'http://localhost:3000/auth/google/callback', + hostedDomain: 'google.com', + }, + secret: 'someCoolSecretRightHere', + + // ##### WARNING ##### + // You MUST change the username and password for security + // Do NOT use "admin" as a username as it's easily guessed. + // You are encouraged to use tools to generate a password + // Preferably, use a local password manager + // If you absolutely must use an online tool, here are some suggestions + // https://bitwarden.com/password-generator/ + // https://www.grc.com/passwords.htm + credentials: [ + { + username: 'admin', + password: 'password', + }, + { + username: 'admin2', + password: 'password', + }, + ], + + locale: 'zh', + + // Support search with extra languages + searchExtraLanguages: ['zh'], + + // Sets the format for datetime's + datetime_format: 'Do MMM YYYY', + + // Set to true to render suitable layout for RTL languages + rtl_layout: false, + + // Edit Home Page title, description, etc. + home_meta: { + // title : 'Custom Home Title', + // description : 'Custom Home Description' + }, + + // variables: [ + // { + // name: 'test_variable', + // content: 'test variable' + // }, + // { + // name: 'test_variable_2', + // content: 'test variable 2' + // } + // ] + + // Set to true to enable generation of table of contents + table_of_contents: false, + + // Configure generation of table of contents (see markdown-toc's docs for details on available options) + table_of_contents_options: { + // append: 'Table of contents appendix', + // maxdepth: 6, + // firsth1: true, + }, + + menu_on_pages: true, + menu_on_page_collapsible: true, +}; + +// Exports +module.exports = config; \ No newline at end of file diff --git a/apps/raneto/latest/docker-compose.yml b/apps/raneto/latest/docker-compose.yml new file mode 100644 index 00000000..26c96c11 --- /dev/null +++ b/apps/raneto/latest/docker-compose.yml @@ -0,0 +1,19 @@ +version: '3.6' +services: + raneto: + container_name: ${CONTAINER_NAME} + restart: always + networks: + - 1panel-network + ports: + - "${PANEL_APP_PORT_HTTP}:3000" + volumes: + - "./data/config:/opt/raneto/config" + - "./data/content/pages:/opt/raneto/content/pages" + image: raneto/raneto:latest + labels: + createdBy: "Apps" + +networks: + 1panel-network: + external: true diff --git a/apps/raneto/logo.png b/apps/raneto/logo.png new file mode 100644 index 0000000000000000000000000000000000000000..4cfb97aa131859f3d6f527fa04a7abf621bdd192 GIT binary patch literal 5755 zcmV->7KG`EP)z=P+neMUteEKY-(R$UteEeUtL{fVq#rcSYuOEU|d{ZVq#uhU0+>Y3ADCeUS42e zU}9ooTUuIRU|?KbU0q*aUt(fhTwGdOS`ERrUtnMgz`9>vUR+#UWMyOx$h``@w_#&q z5!l5Gy|)n3!VJH&V`F0qwyO-hv0z|e3%<5nTU!dcunNVy3&OTsU0n>rwhzL(65`GZ z!n+aM$_T={47#%t+{q5Ds0+uuRY^))U|?itXArx!4$i?Ctf*L6SZYj9Lp?oPTU!j; z%r2jqHkOY_Nl9gBXFP?0K|DJU`=dx)9gL3ck2tU|i%QyS8CkT4Y#QX;D%S*T!U3R$yCP48^@*U0n<0(PmLo5!c28&czew z(GKFzVq#(n?A8h3&lBX&0>;4s!oLK+yB@~3SY%@h-pvEj$Xj7yX;V}R@!AgO(+0b_ zK!t%!baDse(+SAHQfzBwSXc(!&I{YiVOUrL$-)H0z9pfY2i3_5(Zy71XjW%tWm#Go z%)B7KvJ17cB)6*>t*AGYjXjKpMSXfncy(oEWob@O6YJFq%)u~%Y2*SJ?$+|0>mM^558M&|$vaU0ajAK((3&p$>ytFi&lxSXG zE0&ZQ#<&;4w=a~CZbe86vc23r|GxkL0CRLwPE!B}8i~yd;IF$jB@%RMFvb(4@{(Bh zVN~jXOe6dC=+eM2?VOjFib_d48`^w%ZeKw_D*pA?y|%QjW>ZBw?7+RSoncx2=HINL zetk3f_3!KDEhwm%B_KYQP*I9F8}}%$w@>( zRCwC#m}^LzR~W~S)_QGqZP%{rM%z)>x%;gY%5L3--PoO7*#&lEpEejtoaRQhM5AB` zNi76K44MljA)4ev&8niJi67LeICax`1C`E#tYu>#_nhaP=BTO6p(nGWzxO%Md7g95 z%lkjaW8Mq7!3}Qkzu~!;o+CGX`3Sj=xaH`T`71BJ{qY;eZzIEoiYgEWzL#$G80^$;%$3lH1xM76!jQjY+>X)3rQ3jH}GS z)jmJOt?k3xWod=H0`)B5w=qfwlxGI~9#(-n*_(?`;d&>AMOB=ewsIZS594Dg;10EeKs>6iwS4k;%#T|9jboGUxr>Q`)wmR_}mA z55g$iLzOUw-ZDA)AFuYqSv?a2OKR8{T2M$uC%k|PW;Ghfj+}ak{8v1e-Q&8jRMOVY z1ShdxtJV^nJbf2QIk?JKTrHOaZS7jU7NzJpA{2R2!{p@2)XPr4b&ME{C$|Gk$xhsRU&rTIPhu0F5~wtWYdQXiG|hg+wBG zy9!$C;Y})p+O~=ky+z)>-nlEY)iXUzSDEe%bhL&8jpd0hkuhVHa0u(NJbw?7!z~5# zp79Ybxr82EJ6A0XVFS2m)GVgT!JK+!5*o38FDWvEGsnv;a9H#C8NMqM(w zRgc*D&%D_>u%rns=yYneS_h^?4++MA5{`s^NCj%{a0E}2YB9$0=}lX+%7?GaOhwz; zd~0bEs5z(@Jvbp>%?#i%kFbbyXmjK}vT4!|WZJyb!}g(bE4fG+0%m8ypp>Y$2%XaM z;HEzdWY`o6#lQtc-73xlEtCtuz<{E|r(`=vw|UhIuW#zJaPIw2HaFV0N!{N3`HA1!E%ypg2(sl+p&i1jMWs}TMd7S2E{p_4mEEW z6u3I&Xw;GW$kvj!8nT;iAMf&1d*YhtMfUH}C>@f&h~)2A0RFKqr3TP}LE#}LEXM>u zkIgs&!_^Hm)_*Pcg&-}{Mn(S|Z_=!SD-eQtV=|&c%tK#Dq>|MPqI+A0e4348{HK1k zUha$Tt#qXuJtJL4jnN2&ns6E@+yK@rYJ}xHzFHT<3xPy#RsePW%Raaig?RxgWQ_r9 z09EOf(P-Eg4d9fxd{$_TfqUT;kx2gS)ganA9n~2rR`gg4)F3h(Zu0rM;0TAKx^nyM z@I^HrBoI@!YAg>Bd8B3FFLk#)ZUqh0pax?x(`BC>`s3X2$lTP@<G95)?z;0M z;l%WCG@gnPjRP8ZA&^HF6b+iXBcQ0Ru2$69COX1V zK8)kWleuE_+T%nThnnfnhkwjx4VVBB4TWlTg9S_ht10})U{77O&9-;%-u;IQ3NkW| zesItpHo2_ySImK z>Uy}nl$V>pP$n;|!D?K+JJY`L#o6rmp!KjWJV+#QzYX`t*hepj?4z#om0;XH|(FF?wwiZ+!JG zB87dpsXa?!!#b#R$Hl*`H42(HjD6uWk-{z2?Cm9LP=OvODuC5IQl4J9p$*sxo;rxQ z=Mgu6HkZFD>B+hXSK8TWC|9k6>FRAF?**z^U|?Q2-kF$2_$eZX^v~Gs<&U^(UDXfq z4IOpcRU5}1t$6ZrA_v^m^}TapdL1sxPAyT4>~s0I<#9Wt453~$iL;RMSVwE7q?g=7 zHhg9pMbTWforQKL#8k*PG-}3nK!i|43kI|{hvz)?*+dTc_)G1Yj=QM@GnfiIs%0AN zhST(s+m!WoFp%0B{}#`l9+y z)KG(pX<>bK7*9jC)KIe%Rp97<;pl`di^u}MBh=Slika6z6}_8$;EvT?ozOK%>Z*xe zsvpcqC$iYho|%@Y=qfC5RGFdh+HATjcO(W8YvYZG2zbV;8n>ad^dYvPX672xolnOxK|m56gWc#TY_2rLMpgLoMB@%3k5~5NFLh^?f$0TbR>K0` zpt@)_V1i<)ui+zEjLkGaU_@E$PesqcbRv(mqxehR@@F4tEh{TSNg#k`G=e#(R5hrx z3`HV5X3F6l2+{CN)#A9n`DP-MJqp0vI~PAwCa7Um6^7_A#sEFmd=MK3jtxB%oANhi z6KRMqdd|^UX<0(H;0zWXV}MSObWZ7FZHv?P1d+<)ztBzXAMdLIRZJv6uZ|(LQq}|q zZxQ-2V&i#>DmFG@J4WP^mq|rC2WtCD&y<#)fx={}lV{^TY z_vR7F6yO&<@5my^OCUlj6di3uhi!>kjK?V%O1qu=^NDQmJA&7_6f4~*LMeBGsu!u}i%Td((+@augI#XKDZU-!nA;NTP<0reGMXlq*Ig^8Wsx z{mr|HeDV(C7vJ;0_kkvA3DFFUcpIy+aD-s6ir8;{TQ*4r*|^^l^!H7>YBp=}i#egChn=j6(JDM{}rZ|A6)A!3|XJg!YdokvxG!Aqx zeja_?p4On~a{BQjbvPqt2+q`r(k)LzqSJ-g*?H|5Au?u)y+}7C`j~P55k%3{^b|4E zWy9n208T6=@|P23C+vJt1$+8g8%E9)A^J%+>-izsY17Jbud3T{Uzo$l=^$>0y!g`a zAn_Wa(}f3~vKzlbDY>$C?oOX*nHWqI1wXzVFAj0?6aK=V#aX7uzHDc6H+*8KyFr#Bq2i*F6r z*9TnX5saSB*wc|aZ_8YQ8~OH|Q912sieAZPzftXhYow&e6}_`(N`~9za^YJ_c3E5Y zrnM0etZ_Ar<<^kcZQ`|BKN^M&hYVix{$Vhlt<$W7(J`}7&BeYy>Zpz zjdAZ%g4g0xpG>R0QsWGI!^ERh^2M`^fB=X6Dsxa${@rG;0 zCL!_hjGQiL)MuU=iWd}ky-Do5n^BG-*6)8jc9B+JjGe%7h+r8LQZSlMS(YDDp z?<)pl%u&iIRxR=A9>u8XZM&D}pb@3ol9B90c{h&g;GDavpfb4MuDrYDScOdl@A-Q)A53RQjH1pJyhMv~-Bs8qE5OhF#yysKIrFM5K`O zdA+zwl= zDasf|OdnN6_mWqnT6}ZSU%9)Eeg_hLY(5uNv6U|J1ZJ*Z#q6b+_kDx8>ATnQAR~C6 z1F;sGGK@HC!gU06FQ%;lH|*&2p0DScUJen2oGImeQuRslsHqM5=hN?Vnx^^SB{AoJ z8-NS5ZaRHiH#MJqf&vw3X`u=;%`4hhWWSRE4!1+6`=+Rm(x**jwDdkNW`uBF`x4)< zvEP~3y9m{1xLIpRKnp0;QB&uED8f-P0{|$n2tS|sT^DM_)-VckVJ;cAurj?BBc)Yq zRB`PEik4`~teUq!p;_N4Cc}0s71F3lt|L_PQg9eHWzg7~DLfK=kbiF1S7tI=I;!G+ z6`v+W|4>I4d$xX^)1YFQ*QZQi+8T7FZ_b?shNvo>|>1nQyKd>#gR zXP@Tvutclfcj(U1tS=OkIzK6(YttDmL&T;1*Cq%630UgpLROo8RkMDcLe;va5HI_7 zL^pToem($#1>sj;siQc|}G=GXl=$?mjNnl-8pDiawgZ5`r%6*Cyr;l;_XWasPK84JUk_>Z#Xl`=A5%#N;50akk_p!BkRTcf%wqL0<-BFqr(w2+<_;oFVEXtm zq`q1V3eAJs*Xc{oTZ!()QWDP7NTa6aeO2LJL|12K)SVSusxLj!Gtkwv2~0~2^sc>2 zhJavlb=|G)ZpYS_lX@tqktQ&0#58a@g&l3IVf8YnuWi;Zk}&I$F8fY+DCRCb1EQ1b ze#J4VA|v3oRSc3wP5n`HnAXLfb^kj1*GEP^Q@Kmps#f zhgNL89}HwIBc!E@_5tptm|Wh0{R&Hj=%z%Mg~?)uY}r??Bisj@PVH*sViTx-c4S5< zL=`p3hjk+0UNWI}job?bT-exr8%8ZutU)hvrs-)WwYJ%>j|fzKaXXt73e939$aRE7 zR2SPaHa$a_!1VEBN`57|udLNljc@v z^}wEtbsbOB)p8v{UCbI~r611k0`uiqI??^@q0}hNz^qmOTt-RzUMlY?)-ZUzPHn*` zX~rMc@%Q`9`}NhhJNp>+|RRtvfI> z@ZPF{?SB6+L->0$N{0N2r}Wx@SEQudpLo`${X>6yM#$lZ?f*y))QJ(&v+bXW%*Qc8 tIyC=7UaAlK_h{dl{pUab`Okm8