mirror of https://github.com/teslamate-org/teslamate.git synced 2026-01-24 21:06:08 +08:00

Files

T

JakobLichterfeld 27e2ea1a8f docs: streamline installation guides (#4829 )

* docs: remove manual installation reference from docker setup

* docs: update changelog

* docs: add nix develop to run treefmt to support non nix direnv users

* docs: update changelog

* docs: add Unraid installation and maintenance instructions (no support)

* docs: clarify the use of secure connection to access TeslaMate

* docs: reorder guides into advanced guides, categories FleetAPI documentation as config

* docs: clarify which installation methods are supported and which are not

* chore(issue-template): update bug report template to include Unraid as unsupported installation method

* docs: fix sidebars link

* docs: state in title which installation method is not supported

* docs: nested entry for unsupported installation methods

* docs: nest unsupported installation methods in separate folder for even more clarity

* docs: fix links

* docs: mention dedicated version for MCU2 upgraded cars

2025-07-21 13:46:20 +02:00

docs

docs: streamline installation guides (#4829 )

2025-07-21 13:46:20 +02:00

src

Migrate docs to docusaurus

2020-04-07 19:32:18 +02:00

static

feat: add total ascent & descent to the drive table, introduce slope-adjusted efficiency metric in drives dashboard (#4798 )

2025-07-19 11:07:02 +02:00

.gitignore

Migrate docs to docusaurus

2020-04-07 19:32:18 +02:00

docusaurus.config.js

chore: rename branch to main (#4700 )

2025-04-26 11:06:31 +02:00

package-lock.json

sec(deps): override webpack-dev-server to version 5.2.1 to fix CVE-2025-30360 (#4833 )

2025-07-18 13:40:56 +02:00

package.json

sec(deps): override webpack-dev-server to version 5.2.1 to fix CVE-2025-30360 (#4833 )

2025-07-18 13:40:56 +02:00

README.md

style(docs): fix line length fenced-code-style, no bare url links, multiple whitespaces, alt text, header style

2025-02-23 14:20:57 +01:00

sidebars.js

docs: streamline installation guides (#4829 )

2025-07-21 13:46:20 +02:00

README.md

Website

This website is built using Docusaurus 2, a modern static website generator and automatically deployed to docs.teslamate.org.

Installation

npm i

Local Development

npm start

This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.

Build

npm run build

This command generates static content into the build directory and can be served using any static contents hosting service.

Deployment

GIT_USER=<Your GitHub username> USE_SSH=true npm run deploy

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.