Skip to content
desktop-commanderPublic

About

Desktop Commander help center, served at desktopcommander.app/help

Resources

Stars

0 stars

Watchers

0 watching

Forks

Latest commit

 

History

17 Commits

Folders and files

Repository files navigation

Desktop Commander Help

The Desktop Commander help center, built with VitePress. It will be served at desktopcommander.app/help.

Articles are plain Markdown files in docs/. Found a mistake or something missing? Open an issue or a pull request.

Run it on your computer

You need Node.js 18 or newer.

npm install      # first time only
npm run dev      # starts the site

Then open http://localhost:5173/help/ in your browser. Pages reload as you save them.

A new article file shows up in the sidebar after you restart npm run dev.

Check before you push

npm run build    # fails if a link points to a page that doesn't exist
npm run preview  # shows the built site at http://localhost:4173/help/

The build also writes files for AI tools: llms.txt (an index of every page), llms-full.txt (every page in one file) and a Markdown copy of each page, for example /help/devices/connect-computer.md.

Analytics

The built site uses Google Analytics, with the same property and cookie banner (Cookiebot) as desktopcommander.app. Google Analytics only loads after a visitor accepts statistics cookies. npm run dev has no analytics, and the cookie banner only works on desktopcommander.app, so the copy at desktop-commander.github.io sends nothing either.

Google Analytics records page views, outbound link clicks and scrolling itself. docs/.vitepress/theme/analytics.ts adds these events:

Event When Parameters
search A search the visitor paused on search_term
search_no_results The same, when nothing was found search_term
search_result_click A search result was opened search_term, link_url
related_article_click A link under "Related articles" link_url, link_text
copy_code A code block was copied code_language, code_snippet
file_download A setup script was downloaded, like the Windows .cmd file_name, file_extension, link_url
page_not_found A visitor landed on a page that doesn't exist

To see the events in the browser console on any copy of the site, run localStorage.setItem('analytics-debug', '1') in the console and reload. The form_start events on the search box come from Google Analytics' own form tracking and can be ignored.

Folders

Path What it is
docs/index.md Home page, which is also the Getting started page
docs/<category>/index.md Category page, one per sidebar section (except Getting started)
docs/<category>/<article>.md Articles
docs/public/ Logos, favicons and images (docs/public/images/<category>/)
docs/.vitepress/config.mts Site settings, navigation, page meta tags
docs/.vitepress/content.mts Sidebar sections, and how articles are read and listed
docs/.vitepress/llms.mts Writes llms.txt, llms-full.txt and the Markdown copies
docs/.vitepress/theme/ Theme: colors, article lists, related articles
docs/.vitepress/theme/custom.css Brand colors
docs/.vitepress/theme/analytics.ts Analytics events (see Analytics)
templates/article.md Copy this to start a new article

About

Desktop Commander help center, served at desktopcommander.app/help

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors