From 42e53511036537c6ea702257465e6e40f8fb17c2 Mon Sep 17 00:00:00 2001 From: Jeffrey Wang <66625372+JeffreyWangDev@users.noreply.github.com> Date: Tue, 5 Aug 2025 01:55:11 -0400 Subject: [PATCH] Add docs for OnShape and fix link style (#451) --- app/views/docs/index.html.erb | 4 +-- app/views/docs/show.html.erb | 11 +++++++ docs/editors/onshape.md | 36 +++++++++++++++++++++ public/images/editor-icons/onshape-128.png | Bin 0 -> 9218 bytes 4 files changed, 49 insertions(+), 2 deletions(-) create mode 100644 docs/editors/onshape.md create mode 100644 public/images/editor-icons/onshape-128.png diff --git a/app/views/docs/index.html.erb b/app/views/docs/index.html.erb index b8a9831..0ec7e28 100644 --- a/app/views/docs/index.html.erb +++ b/app/views/docs/index.html.erb @@ -126,7 +126,7 @@ ['Android Studio', 'android-studio'], ['Xcode', 'xcode'], ['Unity', 'unity'], ['Godot', 'godot'], ['Cursor', 'cursor'], ['Zed', 'zed'], ['Terminal', 'terminal'], ['WebStorm', 'webstorm'], ['Eclipse', 'eclipse'], - ['Notepad++', 'notepad++'], ['Emacs', 'emacs'], ['Jupyter', 'jupyter'] + ['Emacs', 'emacs'], ['Jupyter', 'jupyter'], ['OnShape', 'onshape'] ] %> <% popular_editors.each do |name, slug| %> " class="bg-darkless rounded-lg p-3 hover:bg-primary/10 transition-colors text-center block"> @@ -155,7 +155,7 @@ ['IntelliJ IDEA', 'intellij-idea'], ['Jupyter', 'jupyter'], ['Kakoune', 'kakoune'], ['Kate', 'kate'], ['Komodo', 'komodo'], ['Micro', 'micro'], ['MPS', 'mps'], ['Neovim', 'neovim'], ['NetBeans', 'netbeans'], ['Notepad++', 'notepad++'], ['Nova', 'nova'], ['Obsidian', 'obsidian'], - ['Oxygen', 'oxygen'], ['PhpStorm', 'phpstorm'], ['Postman', 'postman'], ['PowerPoint', 'powerpoint'], + ['OnShape', 'onshape'], ['Oxygen', 'oxygen'], ['PhpStorm', 'phpstorm'], ['Postman', 'postman'], ['PowerPoint', 'powerpoint'], ['Processing', 'processing'], ['Pulsar', 'pulsar'], ['PyCharm', 'pycharm'], ['ReClassEx', 'reclassex'], ['Rider', 'rider'], ['Roblox Studio', 'roblox-studio'], ['RubyMine', 'rubymine'], ['RustRover', 'rustrover'], ['Safari', 'safari'], ['SiYuan', 'siyuan'], ['Sketch', 'sketch'], ['SlickEdit', 'slickedit'], diff --git a/app/views/docs/show.html.erb b/app/views/docs/show.html.erb index 5682426..5647d5a 100644 --- a/app/views/docs/show.html.erb +++ b/app/views/docs/show.html.erb @@ -36,6 +36,17 @@ } } + <% end %>
diff --git a/docs/editors/onshape.md b/docs/editors/onshape.md new file mode 100644 index 0000000..081ec81 --- /dev/null +++ b/docs/editors/onshape.md @@ -0,0 +1,36 @@ +# Onshape Setup Guide + +![Onshape](/images/editor-icons/onshape-128.png) + +Follow these steps to start tracking your coding time in OnShape with Hackatime. + +## Step 1: Log into Hackatime + +Make sure you have a [Hackatime account](https://hackatime.hackclub.com) and are logged in. + +## Step 2: Get Your API key + +Visit the [setup page](https://hackatime.hackclub.com/my/wakatime_setup#show-advanced-button), press on the button called "Custom Setup" and copy the api key. + +It should be random letters and numbers with some dashes in between. EX: 1234abcd-56ef-7891-abcd-efgh2345abcd + +## Step 3: Install the Wakatime for OnShape Extension + +Install the extension from [Chrome Web Store](https://chromewebstore.google.com/detail/onshape-wakatime/kieglbolocchhhcblnhaiodbpgkjcecg) or from the [FireFox Addons](https://addons.mozilla.org/en-US/firefox/addon/onshape-wakatime/). (PS: If you like it, pls rate it!) + + +## Step 4: Config Your OnShape Extension + +Visit [OnShape](https://onshape.com/) and login. Go to any of your documents and press on the Wakatime for Onshape extension icon to open its config page. + +In the WAKA api key section, paste your api key from Step 2 and make sure tracking is enabled (You should see some green on the switch). Do not change the API url. + +## Troubleshooting + +- **Not seeing your time?** Make sure you have completed all the steps above and set the correct api key +- **Plugin not working?** Try refreshing OnShape after installation +- **Still stuck?** Ask for help in by pinging @Jeffrey Wang on [Hack Club Slack](https://hackclub.slack.com) (#hackatime-v2 channel) + +## Next Steps + +Once configured, your designing time will automatically appear on your [Hackatime dashboard](https://hackatime.hackclub.com). Happy designing! diff --git a/public/images/editor-icons/onshape-128.png b/public/images/editor-icons/onshape-128.png new file mode 100644 index 0000000000000000000000000000000000000000..52fc0d70c069c992f9f98196087b4dc0b9cb8855 GIT binary patch literal 9218 zcmZ8{cR1ByAGdLEtQ;I$b{r!stL!b=+4CS2GAer?9D8L)wve5j?Cf1+WJ~spjEwj8 zJkR^b`?@aUy8Qg^`~Hs4_}(J4G?a-6XbCVdFo++kDCmIifw!MfT=2C^%5o3`gSG#$ zf~>A5=57a`r>;$&=)sN8Ncua$$L!4S-{>%7${|!K;Btxa7zAZyOObQMgeN7zb)G)$ z5@4{>`c|1Qg3JD|46}X7C#mT3%FxzuVfNx#{647~Q5Tdw5x)%r@o22A6}tTc-6^xz zG$+V0Yy2l&7VJE(z3PUa%L=Ka5&x{O(*Le9(31R{uD0%$54*Fhq2v-~+~9P#e|Y$w znb~{6%4ew$$$#{;Wzu8Ic6wxctivOV(Ea!4f8_vz`r7fRe5>YhS>+vc!L*)0QMSk;HG{$*XBa+}xI zMG;?~ia5=wWPAOlAu`}W=T4RyC2pPirgN2_@poCQS9Wi_&FsW)XvP-90mo|h;q z4-lI|<$Mrj{(Q&H!P z7F4(>!{b+g&UJPNLvA@y*TJaNKOVDI--nqrLFB7qv0uM_tx~`6-Y=Ncz9D_Yx^x;6 z7)<`!(zJPlbd>7v-q2+#B9hX;z##YYXWEg-c6{|L37W~tNyoVPyl7+C@z@5%vWelt zZ9I-1818p0#`d=d$y$S^+9oDG=iO8mmtDE?VHyrXv_9(UF;EVLC53wD#n|`a9)bpy z=4+irI2x+HY)8Zf(t3iKrj6{hrFm1V)Axy_nX@E){zjc_Pf0J1k87{4ulE)e6@6dN z4qzBTwc|H7HU{dbnwptCTw%v$zY+1y2*~rm#kiv}WVRQyrtKimamoPel!=^o67@SC zSH5ZS`t$qdx0r^-)2FNo%F5r5j$RQ7Q_Alcv|UhC&p6VPG&}4JEJ>^R3i=l{w>=TW zz}1Mn$MZXcr{`ikK%v-&4a(d|kz%v9+8dW$Z#(=hdSqlIrL(h>tI1SDIhH=+#}9p? zdnjf&DQQP-L&Kol9$ht)tKKh>&}LtFrfH@DnSQh}VL&QUY|Hn$Df5J{Y~Il8GdthC zd)?;7#$5HawMax2^|J?dBO&9@pFw2fT``3$FM6sOl@=I}v5Js&E>^~CPzkbT%ohoz z%j{F_+C_A6mI2!wxwDVAEWBc05%!O^zTN*YmS#7UCR?u0{pQhKT=EX4WwARocBAZy zii$iFd75vOmKeMC34O8P1Y!a-tX*^QLPNxlgERHowe>y=`s$yPm`)i41}@#?Z}83< zoERT2Y&Fa$y<^B)4^?LH3TZv;p`#{(1S2=U75@4fK~7|&Xmp&H&=&iI#4A0y#^1#X z4!8DWXJ)l0Rw}++E*{Bpr*Hhrm-%u8Q--33z;qV|!My2hXZC%Mkft0q$k_Z@0n z+767_Pd0?^yR+T81_rNLi_SFeo<2Vg_P1fk>;7nbjcqUhcJ~D*7&@30fgqS2S+0o;$f+qJzLQ&}$583BeZ)cG?1`v-pQO`T zU!P)y0XweIE7eaZE8|JgBWsvmW7bp{CGkqIjG)zs4n$sta~cZR-xVUz6#KZ~iQPPS z6H8!*e-VtNG9i>M_swN*c5CRF?7A3}Cy6j=a4OtThFm>c`5LjYv4Py)a%d`k*io|j zL$Qt7BO$aSLR$;cgkDGdEGnP4`R&}}NtRRVgqzdC z7q83yL=MIG8e!KmV1uDHln@4d&pFVZv_2j>_R3mvum{R2u zBIA`=CXFiFlH~uxPQ)h1Bt%hf=YOhy_!_PBx@)C7>U?NOEmDeQBe?KM>f4aZzvI(*@}i#zeo$%fe!WjtYQ>;j>;tEt zw0+UDchr_&yh?_CtLI$GHLG`Jb-p~yC$EH_ZfR)={a&P*-vITtT<#1l`1mnWNLaYv zx2I|G!E*KV)P&T)q06fZK~bIAd5SZie)n1v-V6_Y4; z182?|iz^c6n7F#q(kBz!C-4RtCRz4GW&weOl4729IlF&_FeOC*fv- z1OK=)?M0M&?eazppG)muj50Zr%=fu7nE{)O2H6i%W?%P2(^!v=jC_cfVTwV(3C?TR z-(J%SPCDPuq*oRjBFKshUFObtrbi9ED_K5ma!$%y=Z}Yl#i5+R=W)H7VZeKB;`pXa zSXw%Jh22mEd@w2HYtuaBJ9unhp$E-`<0yWaGQ8w{!K!olA;|g}HNt)bhun9+8!-x* zpsC3J`2z>MOcCTK@F=)$Uszb^Cqy=<5&sUEx3_oryptWG5TY?)B8)Yd|AS?m0|x>L zzSr|w$XxZDP-7w>RDMc2xZf${X&xMluS#26yP&a=TC_`6PF^0{Gb`-DTY*;q!MeVT z6~+q)igj95GXW}GUS3ww&`@#~2mXja#4h|1xotp;c z4pnw=hX_==+Xg&xJ~v}&1P8A8NJ>h^cgmrPia4xAGS*0Iunj(6d{njyKmUk*VAvUe zlr_Yi$RwoK271n8(T@r!rK+F1XPC^8-Q8U=w=KA5ma>8Zgc>dD`~sfU*n1;&)(pwj zF(Al5c5CHh2`Brzt~ygD7AnIPBQutmI&5pSv(^PB;ALb{os6ABIl6t+H1wAI)Kwn) z=D*g~f^-Pvp#B3+4XdSllI-a&tJamwzxi` zDkvyG&U~_Q@$gV~=6oppjYZ!&@lA1b3NoAR-!>K`@Hx)Ys zSrzk!u=fa%^DVk@adFAn+OogP$QU;Xfq{MJg49M)@qu!EAOn?kJ}(JAX#N_5aBK@~ zNoLHQoC}dvI*wkOb8Fp)Sbx4 z8$UzZCfW)?53#(WB0S|dhVChg0Ag*pEHo&e8r^Zc`Mvu2I7{)Q{V`rjl?w52J6l`& z*~+Z6YXv7>2#iQbHK@K`1ROdDhGNuG70^N;I_L8bwT`W!uj5epM@L8T>FM|YwOb=& zV!Dsk2AB8u3HRMS;#~dkDX_RLe zU=e)bbu4A@o}I-uM!S*BAVlN_VUuYr9)l+aiNpcMGeH_BMHnRW;cMJ~r~6?ujy)ux zv#PDS2_O(iP6O1EU($t_{cItsjq;j?;xpMXHvyL1*pDB$ob+r$A|g6+P#NgO({LX) zhS+OjdS)n=Mz&N8Hr}0fN0EF!C^NOVJ5LIq#T^n7lFLk>*LG%V@M2PdN zWeXf!+?Cug202|_xW9&j1NYy(`KY`+78O!O(uWTpHhLbiP~JBVdGY;2kR`Pkwj5MJ zI|P1*OqYv7LHn!L_Rh}NR=|@(n^c zsO?B*#QC4~uE|LX>7wFdXtwVWJ`paqcN7eTM&o|D`ukHwRaMU0`_Y${76FCuVOwQz zh=G9tmk0E08z{~3Oc%|i3wfb^R?6} zLmn4MAshz>2f@qRvo%>N;JTtf^oT%98;E1P0+;xuwKc_zckg7N9mogiYR?@Uu)FwO zl2TKtzJ2?~Z`lbsrtEc16Lz2ktm%5NB%3MaM;rU;=WcO%c{fmo0vpg`x!k~p22o=Z z6IZaeiK!`aS(prGw+l<^pn%;7{m^@Hs#i_)e#?7%vA|tf&(^+}Zua2g;^qdmTO})d zAX#Tj403pOb~g6=w=F+W@N%F|r0Z%Av!vwRg@uI;O=f21vo6N#K%g;J+Jmq+_V#+J zWMsU8l%G5y1P92Ow0{hK0=cUpBqI9y$z~8nP97X22kl7We9G^C>G{mYW*KZ12EiPO zjf7K1;efQj6cZxzpq>0K`n7G{lVY(dcwi7+xUN}T^ngc1>jkmsLeWoI*j$F%hI(Tp%L zKD4FF)O{@&0l|9>JWe7uz{yoSgsPl-Z`q+(nUt6milp8x3_8>*8=ITCD5j-~Wp%hB zKM^)~6g-z=Bg@%s)L6(WYQ@%(297rQdde$zjoTQbC z*8C(uj4}k+_~h(r?Ib_CrD7hkQU%}R!Hue{LrUQpWaB;Dy z7Lozl?d|c@Y%e8W?0g%pr}c@82p4Qi;_tMz=ieDSQZh0u5TVcNkb~3HFmP;pdwXQf z3@A@c*Jz@W+|B7nHhAn8>UfwPNGJ(O@9R;?Fl9zR_}<=L3f3-6sRo2n)#Zq;9K@zq>yV_nPyUbb?pf*O7v@y6Kl8x(GKH-!0 zq4}3)r~}<^gVX%KaiX=(yR_Y#?}pvE+X>V_B;ePTiiI2`H7-{&!EN-px$_t0pJ-xV zu=I1_WN@?v*M?7m;ER3C&&S?xyOCP({i8lHIk{Z%lNE|3AtAvO8XVHoqXd9vr{YZ9 z7`xKiXd)l#f{$i3?6fl9&{6xF9rPvTfeV}&Vq;@7{n?HC7SeDCDcifdaXcQghU63$ z;(&$Iqywa=(U?%#$I6)IlBaBcb$u~{%jsf|w4Mvt{bD($D1>upWVZLj&?RJK5X!>% z;fULwOXq|Wu-&^S3&IMf2i-Taoc=PhhwAgpUp)Wf19Jm}zIAc>u&wXKX3=#0OS+FA zKk~ytAwQ@&HjGb9yzL<^Raq!zAza#ad3ajyTFPAV1|BJXv`n2hg z4>4cSwkj$8subuEr-@|>L0+C60xQrC-tF?Mj}-9O0!v6vSs78l#rJIfm$O1V=3l5m zi8UO}dn_*h51vPJL2E>2uZZ0_T?~-kYrF9W3{7-b6{6i<=P-3!S%3e!ce>JhM+N50 zOawL%HXv)=CBEhVU>dVwqtDesR3SUC)ZPi<sAS&#h%VpUFhSsAUl zgt%`bazoI}D4gZNW%k!$tbk*yo#r3S`Rup!4Gk%nnce-5%66FIy_GyPG&JFnk*E%2 z`}Ng7*WW`lmtcsf48g-=1q>x1AmBm^N#ZB^ppg*?R=*Y3eIp~dg>b)nI+z?=ZJkZO z>4B?^-3qaiy`vg0m}`&I=9G;s8v z;U+_PE7o`Hb(FQ(F(oqukV<%5T<`xX4Rp~lhp4D1kvKd=hd>r~TQyr-_5=JxxWVb7 zRvz7phcB;4c^K;`4`-{Hm^SXmuJSuCNT{U?;-sgi_YDqWgB0XW+E@FYzXC=Bw~Mq8 z4(JDPzgCH^LgiF24AmhcGX@Txkt)hO!i`U&e1q%1B_k%6KaSj;t-IAcU{n=4J8OKL zqQ)+7Z_o96C>=Xp4Ocl_SHVeML?YRk&0DiQhZVyT`rk4`HvBA+%WX%pG9k8kzLu_M zeQm*f9Zy+JV4u!SPfAINzMW}O@tVp2Hw3hvld_Hu8IWv1R1hnhZS(f-9i6&%X@%Cg z-o)n07Pk`~jCsmcPW{KOL7_70>cr?s8Ju52zA;hdMFP@7*rzyr5P9JCK-z^~kiC8T z*5&NL^47uu7P9sA^Q(585oBXyYuCm#5tXXEfY`m$Si*xqSAPbqkBvYr(T!2w_|;xho$6MAd&KInbzJ7A^w~dhlFiYBhk@x##)*vu6tBvVnst zVx5bNjBQuD&f2D?(O?n#8iJD$ZxEG$z4AV1h}NPDh^*A0HSJ0y$P}s3XMtDBZo;v+AN6 z0y1m{@&ayHj$8!LdzZ?KNQ> z{g)vwNI#dmqsU-UF~8)FMwCqP!};3%%SBZSW|r^Pb;g`*Rq;TcM4X*@>Si^&)*Wk| zNY&|=jGKDuB)G(HS}i_SzlZoGV?@Z5^YZf%1*=t#^wHPj=@Ts~%*mY#Gy zIRvUM-G8=ek7i%52{!r9HM&X) z3k%BuyX=1_>Zi-emL3>tM1h&%x)Hi=GF50EG5m4lSGioNbJ>&_nw3k8run(NtDV%5 zNn5b~L#);H73{-3QRIFkMJ8gr`bXJ(Lys)>tfkR{bpLJBP zs&w16z>_8sK0eLC&QQW#BO{}vThB+?a(in>OeYdvUS94l-!QI|y69WD^8Dq8*(d$a zyM!KNP>YdbVda~}5#DcVtl(1)H-XIkqE#U+39NMZyV{aBrR`9r6cF+MuIm&wKh$96 zS^2B!yR)f(_rg7WS9-h1sHhqPUET1|(9jKH%9f@!58mwmLVr!?xkz!r|db z5iM`MjZa7;ZsS=o%TkE({o%fsedvWBFd0WF`1z3vxvJY~4zoOKY& zldy9AUoEZLO_zS!UX;Eb2< zQAR0J2u<3VAH7RkH&ZIMS}HJo=9I?xF4m}nFb5Q^#hP;Cv^OpUg1y`ko(z5wWO8md zW8wPokhQ8}t4T^Yex@Ko}VgIPxrg~<~V z(?yc@o$c+Ptf_;c01>~Qp`Rf=N;b*NYhRRtsoJ@PqK4~VbU}&n=EZ1xD4sGVZ zKrTH~`$CFE!9Qm8r3aa$Eb)I!|59aiQeJr9uleMgw^`FUDkCGq_3zG%%;{II zFDJ(@{3c>GwBh%a@)P*@_`>?1$pu&mU<}zlP|z+Q2$j=9z(vf0TkE)*r3UBhxxXnj z$0d}A@m->#kJMyp?Xdo{Q;HKCVY@}n>#I&IWYE)BJ{$35btug|!>yu5Ji>t@Te5RO0! zVd2trz|zHBS^7su?P$>2kuWn>TbvQPHj&@=lEYYtJkln{-ta^ihB9uPT=dvwdD#w* zycZ{#-gVChiPS5dJOa1daQQ%FcqkhE7Q`wY5vi)*?Rk$k?&2gZx^Iy@wsG~2fG8XB zlTL$~MW7JdUe4BTzOUbZQD-~|ILR|0AmH%qaFv=1qJacAyFhVU9ecN!!XU}tOeo(T z8D8#peZaYl)KTRhdO;T)x3;oPR7pv2G4@OR2-jvM~@4`NUtj8pA-d4xo`Z(HkJj9sgWa#)j z=pX&l7^n1mzxht5LphGx#yzW5GsaTw6Qm!@W%ac(k>=6S<7Uv%cL zh9sSV&d1ay_YFpG%AZ*ed#D$g0{$l@CDjL3<`4`s;TqA%w1Yo?So08q-Yw?LP}D46 zKlj76!!rYkt~vG~t3IfRwn38DZp>hIN&t`buX+036Cn6PM~8VJY?^td-;7%<$Kg!<#~1m@gBAn# zYRHLnmhjrk&A~{2*t~;%gO!D)4BXYPt*ybk;2rOS&i?(Y0rv&3wBeJO{Zfe>QVb2_ z)&(X67np@hrJ6qiJP*5$M9agxE| zSUZTqAO=E@Hq>KfpqOKYGE`F5Ft6w3C)%C5R4J~X`d$V8(!H*>R8*;18ynA;!7U2h z1BMbeG&H3CK0eM2=1KSe*s`!oW*w*8RvY>C%^6`CRv|IcK;@?z+0VrmU=3 ziDN{H!#eJ2uqToN*!%HZXy86&)Dx|Na8Ay)2%j12f}diS)R^xo-}w6ZEBD*ZyID7> r777*>6ih!77w^8j^qniYrV_{4`BA{|4g6CN2F7DW4TTChB