System-End/hackatime
1
0
Fork 0
mirror of https://github.com/System-End/hackatime.git synced 2026-04-20 00:35:22 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

format docs using standards

Browse source
This commit is contained in:
Echo 2025-05-31 22:24:22 -04:00
parent abaab7d5df
commit e0c45879d3
No known key found for this signature in database
5 changed files with 34 additions and 36 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
docs/api/authentication.md
View file

@ -74,15 +74,15 @@ If it works, you'll get something like:
We don't enforce hard limits right now, but be reasonable:
* Don't make thousands of requests per minute
* The WakaTime plugin automatically limits heartbeats to every 30 seconds
- Don't make thousands of requests per minute
- The WakaTime plugin automatically limits heartbeats to every 30 seconds
## Keep Your Key Safe
* **Never put API keys in your code** that others can see
* **Use environment variables** to store your API key
* **Only use HTTPS** (never HTTP) for API requests
* **Get a new key** if you think yours was stolen
- **Never put API keys in your code** that others can see
- **Use environment variables** to store your API key
- **Only use HTTPS** (never HTTP) for API requests
- **Get a new key** if you think yours was stolen
## Need Help?

10
docs/api/endpoints.md
View file

@ -63,12 +63,10 @@ See someone else's public coding stats.
"user": "username",
"total_seconds": 86400,
"languages": [
{"name": "Python", "seconds": 43200},
{"name": "JavaScript", "seconds": 28800}
{ "name": "Python", "seconds": 43200 },
{ "name": "JavaScript", "seconds": 28800 }
],
"projects": [
{"name": "my-app", "seconds": 36000}
]
"projects": [{ "name": "my-app", "seconds": 36000 }]
}
```
@ -84,7 +82,7 @@ Get the raw data about when you coded.
**Options you can add**:
- `start` - Start date
- `end` - End date
- `end` - End date
- `limit` - How many results (max 100)
### Find Users

30
docs/getting-started/configuration.md
View file

@ -12,9 +12,9 @@ Link your coding projects to GitHub so they show up better on leaderboards:
This helps because:
* Your projects show up with links on leaderboards
* Other people can see what you're building
* Your GitHub activity connects to your coding time
- Your projects show up with links on leaderboards
- Other people can see what you're building
- Your GitHub activity connects to your coding time
## Set Your Time Zone
@ -30,19 +30,19 @@ Make sure your daily stats are right by setting your time zone:
Hackatime only tracks:
* **File names** (like `main.py` or `index.html`)
* **What language you're coding in** (like Python or JavaScript)
* **What editor you use** (like VS Code or Vim)
* **How long you code**
- **File names** (like `main.py` or `index.html`)
- **What language you're coding in** (like Python or JavaScript)
- **What editor you use** (like VS Code or Vim)
- **How long you code**
### What Hackatime Never Sees
Hackatime **never** tracks:
* What you type in your code
* Your passwords
* Screenshots of your screen
* Anything you type on your keyboard
- What you type in your code
- Your passwords
- Screenshots of your screen
- Anything you type on your keyboard
## Hide Files You Don't Want Tracked
@ -50,7 +50,7 @@ You can tell WakaTime to ignore certain files. Make a file called `.wakatime-pro
```ini
[settings]
exclude =
exclude =
/node_modules/
/vendor/
*.log
@ -59,9 +59,9 @@ exclude =
This will ignore:
* `node_modules` and `vendor` folders
* Any `.log` files
* The `temp` folder
- `node_modules` and `vendor` folders
- Any `.log` files
- The `temp` folder
## Only Track Certain Projects

10
docs/getting-started/installation.md
View file

@ -6,8 +6,8 @@ Here's how to add WakaTime plugins to your code editor so Hackatime can track yo
Before you start, make sure you have:
* A code editor (like VS Code, PyCharm, Vim, etc.)
* A [Hackatime account](/)
- A code editor (like VS Code, PyCharm, Vim, etc.)
- A [Hackatime account](/)
## Step 1: Do the Automated Setup
@ -60,6 +60,6 @@ After setup, start coding! Your time will show up on your [Hackatime dashboard](
## Need Help?
* **Not seeing your time?** Make sure the API URL is set correctly
* **Plugin not working?** Try closing and opening your editor again
* **Still stuck?** Ask for help in [Hack Club Slack](https://hackclub.slack.com) (#hackatime-dev channel)
- **Not seeing your time?** Make sure the API URL is set correctly
- **Plugin not working?** Try closing and opening your editor again
- **Still stuck?** Ask for help in [Hack Club Slack](https://hackclub.slack.com) (#hackatime-dev channel)

8
docs/getting-started/quick-start.md
View file

@ -29,7 +29,7 @@ The setup page handles all configuration automatically - no manual editing requi
Hackatime works with **any WakaTime plugin**. Install for your editor:
### Popular Editors:
### Popular Editors
- **VS Code**: Search "WakaTime" in Extensions marketplace
- **IntelliJ/PyCharm**: Settings → Plugins → Install "WakaTime"
@ -37,7 +37,7 @@ Hackatime works with **any WakaTime plugin**. Install for your editor:
- **Sublime Text**: Install via Package Control
- **Atom**: Install `wakatime` package
### All Other Editors:
### All Other Editors
Visit [wakatime.com/plugins](https://wakatime.com/plugins) for 40+ supported editors.
@ -70,7 +70,7 @@ Check that it's working:
- ⏱️ **Automatic time tracking** - no manual timers
- 📊 **Language & project insights** - see what you code most
- 🏆 **Leaderboards** - compare with other Hack Club members
- 🏆 **Leaderboards** - compare with other Hack Club members
- 🔒 **Privacy-first** - only metadata tracked, never your actual code
- 🆓 **Completely free** - no premium features or paywalls
@ -95,7 +95,7 @@ Just run the automated setup script on the [Hackatime Setup Page](https://hackat
## Frequently Asked Questions
**Is Hackatime really free?** Yes! Hackatime is completely free with no premium features or paywalls. It's open source and maintained by Hack Club.
**Is Hackatime really free?** Yes! Hackatime is completely free with no premium features or paywalls. It's [open source](https://github.com/hackclub/hackatime) and maintained by Hack Club.
**Which editors work with Hackatime?** All [70+ editors](../#supported-editors) that support WakaTime work with Hackatime, including [VS Code](../editors/vs-code), [IntelliJ IDEA](../editors/intellij-idea), [Sublime Text](../editors/sublime-text), [Vim](../editors/vim), [Neovim](../editors/neovim), [PyCharm](../editors/pycharm), and many more.