Skip to content

Commit 42e5351

Browse files
Add docs for OnShape and fix link style (#451)
1 parent 05ba02b commit 42e5351

File tree

4 files changed

+49
-2
lines changed

4 files changed

+49
-2
lines changed

app/views/docs/index.html.erb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@
126126
['Android Studio', 'android-studio'], ['Xcode', 'xcode'], ['Unity', 'unity'],
127127
['Godot', 'godot'], ['Cursor', 'cursor'], ['Zed', 'zed'],
128128
['Terminal', 'terminal'], ['WebStorm', 'webstorm'], ['Eclipse', 'eclipse'],
129-
['Notepad++', 'notepad++'], ['Emacs', 'emacs'], ['Jupyter', 'jupyter']
129+
['Emacs', 'emacs'], ['Jupyter', 'jupyter'], ['OnShape', 'onshape']
130130
] %>
131131
<% popular_editors.each do |name, slug| %>
132132
<a href="<%= doc_path("editors/#{slug}") %>" class="bg-darkless rounded-lg p-3 hover:bg-primary/10 transition-colors text-center block">
@@ -155,7 +155,7 @@
155155
['IntelliJ IDEA', 'intellij-idea'], ['Jupyter', 'jupyter'], ['Kakoune', 'kakoune'], ['Kate', 'kate'],
156156
['Komodo', 'komodo'], ['Micro', 'micro'], ['MPS', 'mps'], ['Neovim', 'neovim'],
157157
['NetBeans', 'netbeans'], ['Notepad++', 'notepad++'], ['Nova', 'nova'], ['Obsidian', 'obsidian'],
158-
['Oxygen', 'oxygen'], ['PhpStorm', 'phpstorm'], ['Postman', 'postman'], ['PowerPoint', 'powerpoint'],
158+
['OnShape', 'onshape'], ['Oxygen', 'oxygen'], ['PhpStorm', 'phpstorm'], ['Postman', 'postman'], ['PowerPoint', 'powerpoint'],
159159
['Processing', 'processing'], ['Pulsar', 'pulsar'], ['PyCharm', 'pycharm'], ['ReClassEx', 'reclassex'],
160160
['Rider', 'rider'], ['Roblox Studio', 'roblox-studio'], ['RubyMine', 'rubymine'], ['RustRover', 'rustrover'],
161161
['Safari', 'safari'], ['SiYuan', 'siyuan'], ['Sketch', 'sketch'], ['SlickEdit', 'slickedit'],

app/views/docs/show.html.erb

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,17 @@
3636
}
3737
}
3838
</script>
39+
<style>
40+
.prose a {
41+
color: var(--color-primary) !important;
42+
text-decoration: underline !important;
43+
font-weight: 500 !important;
44+
}
45+
.prose a:hover {
46+
color: var(--color-red) !important;
47+
48+
}
49+
</style>
3950
<% end %>
4051

4152
<div class="min-h-screen text-white">

docs/editors/onshape.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Onshape Setup Guide
2+
3+
![Onshape](/images/editor-icons/onshape-128.png)
4+
5+
Follow these steps to start tracking your coding time in OnShape with Hackatime.
6+
7+
## Step 1: Log into Hackatime
8+
9+
Make sure you have a [Hackatime account](https://hackatime.hackclub.com) and are logged in.
10+
11+
## Step 2: Get Your API key
12+
13+
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.
14+
15+
It should be random letters and numbers with some dashes in between. EX: 1234abcd-56ef-7891-abcd-efgh2345abcd
16+
17+
## Step 3: Install the Wakatime for OnShape Extension
18+
19+
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!)
20+
21+
22+
## Step 4: Config Your OnShape Extension
23+
24+
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.
25+
26+
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.
27+
28+
## Troubleshooting
29+
30+
- **Not seeing your time?** Make sure you have completed all the steps above and set the correct api key
31+
- **Plugin not working?** Try refreshing OnShape after installation
32+
- **Still stuck?** Ask for help in by pinging @Jeffrey Wang on [Hack Club Slack](https://hackclub.slack.com) (#hackatime-v2 channel)
33+
34+
## Next Steps
35+
36+
Once configured, your designing time will automatically appear on your [Hackatime dashboard](https://hackatime.hackclub.com). Happy designing!
9 KB
Loading

0 commit comments

Comments
 (0)