openhab-docs/styleguide.md

32 lines
633 B
Markdown
Raw Normal View History

---
layout: documentation
title: openhab-docs Markdown StyleGuide
---
# openHAB Documentation Style Guide
## General Remarks
First and foremost we are following the recommendations given at: [https://www.cirosantilli.com/markdown-style-guide/](https://www.cirosantilli.com/markdown-style-guide/).
## Markdown Decisions
An ordered list:
1. Some text
1. Some more text
An unordered list:
- Some text
- Some more text
An unordered loose list (applied if bigger or with nested lists):
- Some text
- An indented item, making the list "loose"
- Some more text
[Enhancement] - Simplify local builds to lower bar for beginners #2215 (#2218) * [Enancement] - Simplify local builds to lower bar for beginners Fixes #2215 * [Enancement] - Simplify local builds to lower bar for beginners Fixes #2215 📄 missing `npm install step` added to README.md Signed-off-by: Patrik Gfeller <patrik.gfeller@gmail.com> * 🐞 problems resolved after reabse/update to latest main branch. Signed-off-by: Patrik Gfeller <patrik.gfeller@gmail.com> * 🔃 Squashed commit of the following: commit 67749101677087cfd016cf7507220bbecc91018f Author: jimtng <2554958+jimtng@users.noreply.github.com> Date: Sun Feb 25 17:23:01 2024 +1000 Convert pwm, pid, map icons to svg and add jinja logo (#2253) * Replace map icon with svg version Signed-off-by: Jimmy Tanagra <jcode@tanagra.id.au> * Replace pidcontroller icon with svg version Signed-off-by: Jimmy Tanagra <jcode@tanagra.id.au> * Replace pwm icon with svg version Signed-off-by: Jimmy Tanagra <jcode@tanagra.id.au> * Add jinja logo Signed-off-by: Jimmy Tanagra <jcode@tanagra.id.au> --------- Signed-off-by: Jimmy Tanagra <jcode@tanagra.id.au> commit 6f39e146f4a622d866dc5a45f60e8826e3da8a49 Author: jimtng <2554958+jimtng@users.noreply.github.com> Date: Sun Feb 25 08:15:21 2024 +1000 Add icon for scale transformation (#2252) Signed-off-by: Jimmy Tanagra <jcode@tanagra.id.au> commit 67a019a2df24ef94101007d69176038fcc464572 Author: jimtng <2554958+jimtng@users.noreply.github.com> Date: Sun Feb 25 00:55:02 2024 +1000 Add pwm icon (#2251) Signed-off-by: Jimmy Tanagra <jcode@tanagra.id.au> commit a03e4c072bcf97e9fdb2d638e880144af80806e9 Author: jimtng <2554958+jimtng@users.noreply.github.com> Date: Sun Feb 25 00:54:22 2024 +1000 PIDController icon: Make lines thicker (#2250) Signed-off-by: Jimmy Tanagra <jcode@tanagra.id.au> commit 7308a413a0aa64194ff0ca37e9ac9a10b19c0ec1 Author: Kai Kreuzer <kai@openhab.org> Date: Sat Feb 24 14:57:54 2024 +0100 Fix typo in tutorial (#2249) Signed-off-by: Kai Kreuzer <kai@openhab.org> commit ccb7e64bf057e6d7051001742312b36424388405 Author: jimtng <2554958+jimtng@users.noreply.github.com> Date: Sat Feb 24 18:15:21 2024 +1000 Make basicui icon a bit bigger and more visible (#2247) Signed-off-by: Jimmy Tanagra <jcode@tanagra.id.au> commit d9664d9ac4be9014d5bc5a73db5f5af5e63e258a Author: jimtng <2554958+jimtng@users.noreply.github.com> Date: Sat Feb 24 18:10:22 2024 +1000 Add icon for pidcontroller (#2248) Signed-off-by: Jimmy Tanagra <jcode@tanagra.id.au> commit bcba38ebb3e48b56ffd8fa3a6aba87ed5c47855a Author: jimtng <2554958+jimtng@users.noreply.github.com> Date: Sat Feb 24 08:31:23 2024 +1000 Add an icon for map transformation (#2240) Signed-off-by: Jimmy Tanagra <jcode@tanagra.id.au> commit f8ebab4e33a374108c741c6575d7178479a9df58 Author: jimtng <2554958+jimtng@users.noreply.github.com> Date: Sat Feb 24 03:23:06 2024 +1000 Add icon for Basic UI (#2242) Signed-off-by: Jimmy Tanagra <jcode@tanagra.id.au> commit ab958f9397cc124b2c2d51b6d04ed4c71437235d Author: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Date: Fri Feb 23 18:21:57 2024 +0100 Bump ip from 1.1.5 to 1.1.9 (#2244) Bumps [ip](https://github.com/indutny/node-ip) from 1.1.5 to 1.1.9. - [Commits](https://github.com/indutny/node-ip/compare/v1.1.5...v1.1.9) --- updated-dependencies: - dependency-name: ip dependency-type: indirect ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: stefan-hoehn <mail@stefanhoehn.com> commit dedb16a37cbb7aa020a77fa108e8d3ae2087f26a Author: Florian Hotze <florianh_dev@icloud.com> Date: Fri Feb 23 16:52:57 2024 +0100 Use SVG logos for DoorBird & Govee (#2246) Signed-off-by: Florian Hotze <florianh_dev@icloud.com> commit 749a656520356ae781130a4dd7f0fac6b4d9677d Author: jimtng <2554958+jimtng@users.noreply.github.com> Date: Fri Feb 23 18:29:36 2024 +1000 Add sqlite icon (#2238) Signed-off-by: Jimmy Tanagra <jcode@tanagra.id.au> Signed-off-by: Patrik Gfeller <patrik.gfeller@gmail.com> * Update README.md Signed-off-by: stefan-hoehn <mail@stefanhoehn.com> * Update README.md Signed-off-by: stefan-hoehn <mail@stefanhoehn.com> --------- Signed-off-by: Patrik Gfeller <patrik.gfeller@gmail.com> Signed-off-by: stefan-hoehn <mail@stefanhoehn.com> Co-authored-by: stefan-hoehn <mail@stefanhoehn.com>
2024-03-02 10:03:26 +00:00
- And even more text that could also stretch over multiple lines