Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/tasmota/docs

Documentation for Tasmota (https://github.com/arendst/Tasmota)
https://github.com/tasmota/docs

documentation help tasmota wiki

Last synced: 7 days ago
JSON representation

Documentation for Tasmota (https://github.com/arendst/Tasmota)

Host: GitHub
URL: https://github.com/tasmota/docs
Owner: tasmota
Created: 2019-11-18T15:43:30.000Z (about 5 years ago)
Default Branch: master
Last Pushed: 2024-10-29T21:23:07.000Z (3 months ago)
Last Synced: 2024-10-29T23:43:20.542Z (3 months ago)
Topics: documentation, help, tasmota, wiki
Language: Python
Homepage: https://tasmota.github.io/docs
Size: 110 MB
Stars: 156
Watchers: 15
Forks: 747
Open Issues: 33
Metadata Files:
- Readme: README.md
- Contributing: docs/Contributing.md
- Support: docs/Supported-Modules.md

Awesome Lists containing this project

README

        [![deploy](https://github.com/tasmota/docs/actions/workflows/main.yml/badge.svg)](https://github.com/tasmota/docs/actions/workflows/main.yml)

# Tasmota Documentation

This is the repo for documentation of the Tasmota open source alternative firmware for ESP8266 available from https://github.com/arendst/Tasmota 

The build documentation can be found here: https://tasmota.github.io/docs/

Built on [MkDocs](https://www.mkdocs.org/) using [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) theme.

## Editing Articles

Edit only articles in `/docs` folder. 

All paths are relative. 

Use strict markdown syntax. See [Markdown Cheatsheet](https://www.markdownguide.org/cheat-sheet/) for a quick reference.

### Markdown Enhancements

#### Admonitions

[Reference](https://squidfunk.github.io/mkdocs-material/reference/admonitions/) of all possibilities

#### Definition Lists

[Usage](https://squidfunk.github.io/mkdocs-material/reference/lists/#using-definition-lists) 

#### Marker Highlight

If you want higlight text with marker style yellow enclose it in `== ==`. [More details...](https://squidfunk.github.io/mkdocs-material/extensions/pymdown/#magiclink)

#### Tabs

Start each tab section with `=== "Tab title"` and indent the tab content by 4 spaces. [More information...](https://facelessuser.github.io/pymdown-extensions/extensions/tabbed/)

#### Superscript text

Enclose text in `^ ^` to superscript it. Example `H^2^0` renders H²O