Doc Site Guide

Documentation Site Guide

This page contains special information for users viewing this documentation on the dedicated docs site.

Interactive Examples

Our documentation site features interactive examples that allow you to test Fitlog commands directly in your browser. Look for the interactive terminal boxes throughout the documentation.

# Try it yourself!
fitlog --help

Keyboard Shortcuts

When browsing the documentation site, you can use these keyboard shortcuts:

Shortcut	Action
/	Open search
s	Toggle dark/light mode
?	Show keyboard shortcuts
Ctrl+K	Quick navigation

Documentation Site Features

Dark Mode

The documentation site supports both light and dark modes. Click the theme toggle in the navigation bar or use the s keyboard shortcut to switch between modes.

Search Functionality

The integrated search function allows you to quickly find information across all documentation pages. Simply start typing in the search box or press / to activate search.

Code Copying

All code blocks have a "Copy" button that appears when you hover over them, making it easy to copy commands to your clipboard.

API Reference

The API reference section provides detailed information about Fitlog's internal APIs for developers who want to extend the functionality or integrate with other tools.

Version Selector

Use the version selector in the navigation to switch between different versions of the documentation. This is particularly useful if you're using an older version of Fitlog.

Offline Documentation

The documentation site supports Progressive Web App (PWA) functionality, allowing you to install it for offline use:

1. Visit the documentation site in Chrome, Edge, or other supporting browsers
2. Click the install button in the address bar or in the browser menu
3. Access the documentation even without an internet connection

Feedback

We're constantly improving our documentation. If you have suggestions or find errors:

1. Click the "Edit this page" link at the bottom of any page
2. Submit an issue through the "Report a problem" link
3. Contribute directly by submitting a pull request

Additional Resources

• Interactive Tutorials - Step-by-step guided tutorials
• Video Walkthroughs - Visual demonstrations of Fitlog features
• Example Projects - Complete workout tracking examples

Browser Compatibility

The documentation site is tested and works best with:

• Chrome (latest 2 versions)
• Firefox (latest 2 versions)
• Safari (latest 2 versions)
• Edge (latest 2 versions)

If you encounter any issues with your browser, please report them.