jpawlowski/hass.tibber_prices
1
0
Fork 0
mirror of https://github.com/jpawlowski/hass.tibber_prices.git synced 2026-03-30 05:13:40 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2
hass.tibber_prices/docs/user
History
Julian Pawlowski d73eda4b2f git commit -m "feat(docs): add dual Docusaurus sites with custom branding and Giscus integration 
- Split documentation into separate User and Developer sites
- Migrated existing docs to proper Docusaurus structure
- Added custom Tibber-themed header logos (light + dark mode variants)
- Implemented custom color scheme matching integration branding
  - Hero gradient: Cyan → Dark Cyan → Gold
  - Removed standard Docusaurus purple/green theme
- Integrated Giscus comments system for community collaboration
  - User docs: Comments enabled on guides, examples, FAQ
  - User docs: Comments disabled on reference pages (glossary, sensors, troubleshooting)
  - Developer docs: No comments (GitHub Issues/PRs preferred)
- Added categorized sidebars with emoji navigation
- Created 8 new placeholder documentation pages
- Fixed image paths for baseUrl compatibility (local + GitHub Pages)
- Escaped MDX special characters in performance metrics
- Added GitHub Actions workflow for automated deployment
- Created helper scripts: dev-user, dev-developer, build-all

Breaking changes:
- Moved /docs/user/*.md to /docs/user/docs/*.md
- Moved /docs/development/*.md to /docs/developer/docs/*.md
2025-12-06 01:37:06 +00:00
..
docs git commit -m "feat(docs): add dual Docusaurus sites with custom branding and Giscus integration 2025-12-06 01:37:06 +00:00
src git commit -m "feat(docs): add dual Docusaurus sites with custom branding and Giscus integration 2025-12-06 01:37:06 +00:00
static git commit -m "feat(docs): add dual Docusaurus sites with custom branding and Giscus integration 2025-12-06 01:37:06 +00:00
.gitignore git commit -m "feat(docs): add dual Docusaurus sites with custom branding and Giscus integration 2025-12-06 01:37:06 +00:00
docusaurus.config.ts git commit -m "feat(docs): add dual Docusaurus sites with custom branding and Giscus integration 2025-12-06 01:37:06 +00:00
package-lock.json git commit -m "feat(docs): add dual Docusaurus sites with custom branding and Giscus integration 2025-12-06 01:37:06 +00:00
package.json git commit -m "feat(docs): add dual Docusaurus sites with custom branding and Giscus integration 2025-12-06 01:37:06 +00:00
README.md git commit -m "feat(docs): add dual Docusaurus sites with custom branding and Giscus integration 2025-12-06 01:37:06 +00:00
sidebars.ts git commit -m "feat(docs): add dual Docusaurus sites with custom branding and Giscus integration 2025-12-06 01:37:06 +00:00
tsconfig.json git commit -m "feat(docs): add dual Docusaurus sites with custom branding and Giscus integration 2025-12-06 01:37:06 +00:00

README.md

Website

This website is built using Docusaurus, a modern static website generator.

Installation

yarn

Local Development

yarn start

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

Build

yarn build

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

Deployment

Using SSH:

USE_SSH=true yarn deploy

Not using SSH:

GIT_USER=<Your GitHub username> yarn 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.