Add documentation (#14)

* doc: added documentation

* favicon

* fix lint

.changeset/config.json

@@ -7,5 +7,5 @@
   "access": "public",
   "baseBranch": "main",
   "updateInternalDependencies": "patch",
-  "ignore": []
+  "ignore": ["demo"]
 }

README.md

@@ -10,7 +10,8 @@ This monorepo manages the source code for `@watergis/maplibre-gl-sky`.
 
 | repository | version | description | changelog |
 |---|---|---|---|
-|[@watergis/maplibre-gl-sky](./packages/maplibre-gl-sky/)| [![version](https://img.shields.io/npm/v/@watergis/maplibre-gl-sky.svg)](https://www.npmjs.com/package/@watergis/maplibre-gl-sky) | To manage maplibre export plugin source code|[CHANGELOG](./packages/maplibre-gl-sky/CHANGELOG.md)|
+|[@watergis/maplibre-gl-sky](./packages/maplibre-gl-sky/)| [![version](https://img.shields.io/npm/v/@watergis/maplibre-gl-sky.svg)](https://www.npmjs.com/package/@watergis/maplibre-gl-sky) | To manage maplibre sky plugin source code|[CHANGELOG](./packages/maplibre-gl-sky/CHANGELOG.md)|
+|[Demo & Documentation](./sites/demo/)| - | Demo website code for maplibre sky plugin |-|
 
 ## Contribution
 

sites/demo/.gitignore

@@ -0,0 +1,21 @@
+node_modules
+
+# Output
+.output
+.vercel
+/.svelte-kit
+/build
+
+# OS
+.DS_Store
+Thumbs.db
+
+# Env
+.env
+.env.*
+!.env.example
+!.env.test
+
+# Vite
+vite.config.js.timestamp-*
+vite.config.ts.timestamp-*

sites/demo/.npmrc

@@ -0,0 +1 @@
+engine-strict=true

sites/demo/.prettierignore

@@ -0,0 +1,4 @@
+# Package Managers
+package-lock.json
+pnpm-lock.yaml
+yarn.lock

sites/demo/.prettierrc

@@ -0,0 +1,8 @@
+{
+	"useTabs": true,
+	"singleQuote": true,
+	"trailingComma": "none",
+	"printWidth": 100,
+	"plugins": ["prettier-plugin-svelte"],
+	"overrides": [{ "files": "*.svelte", "options": { "parser": "svelte" } }]
+}

sites/demo/README.md

@@ -0,0 +1,38 @@
+# create-svelte
+
+Everything you need to build a Svelte project, powered by [`create-svelte`](https://github.com/sveltejs/kit/tree/main/packages/create-svelte).
+
+## Creating a project
+
+If you're seeing this, you've probably already done this step. Congrats!
+
+```bash
+# create a new project in the current directory
+npm create svelte@latest
+
+# create a new project in my-app
+npm create svelte@latest my-app
+```
+
+## Developing
+
+Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server:
+
+```bash
+npm run dev
+
+# or start the server and open the app in a new browser tab
+npm run dev -- --open
+```
+
+## Building
+
+To create a production version of your app:
+
+```bash
+npm run build
+```
+
+You can preview the production build with `npm run preview`.
+
+> To deploy your app, you may need to install an [adapter](https://kit.svelte.dev/docs/adapters) for your target environment.

sites/demo/eslint.config.js

@@ -0,0 +1,33 @@
+import js from '@eslint/js';
+import ts from 'typescript-eslint';
+import svelte from 'eslint-plugin-svelte';
+import prettier from 'eslint-config-prettier';
+import globals from 'globals';
+
+/** @type {import('eslint').Linter.Config[]} */
+export default [
+	js.configs.recommended,
+	...ts.configs.recommended,
+	...svelte.configs['flat/recommended'],
+	prettier,
+	...svelte.configs['flat/prettier'],
+	{
+		languageOptions: {
+			globals: {
+				...globals.browser,
+				...globals.node
+			}
+		}
+	},
+	{
+		files: ['**/*.svelte'],
+		languageOptions: {
+			parserOptions: {
+				parser: ts.parser
+			}
+		}
+	},
+	{
+		ignores: ['build/', '.svelte-kit/', 'dist/']
+	}
+];

sites/demo/package.json

@@ -0,0 +1,48 @@
+{
+	"name": "demo",
+	"version": "0.0.1",
+	"private": true,
+	"scripts": {
+		"dev": "vite dev",
+		"build": "vite build",
+		"preview": "vite preview",
+		"check": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json",
+		"check:watch": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json --watch",
+		"lint": "prettier --check . && eslint .",
+		"format": "prettier --write ."
+	},
+	"devDependencies": {
+		"@skeletonlabs/skeleton": "2.10.2",
+		"@skeletonlabs/tw-plugin": "0.4.0",
+		"@sveltejs/adapter-auto": "^3.0.0",
+		"@sveltejs/kit": "^2.0.0",
+		"@sveltejs/vite-plugin-svelte": "^3.0.0",
+		"@tailwindcss/forms": "0.5.7",
+		"@tailwindcss/typography": "0.5.14",
+		"@types/eslint": "^9.6.0",
+		"@types/node": "22.2.0",
+		"@watergis/maplibre-gl-sky": "workspace:^",
+		"autoprefixer": "10.4.20",
+		"eslint": "^9.0.0",
+		"eslint-config-prettier": "^9.1.0",
+		"eslint-plugin-svelte": "^2.36.0",
+		"globals": "^15.0.0",
+		"maplibre-gl": "^4.5.1",
+		"postcss": "8.4.41",
+		"prettier": "^3.1.1",
+		"prettier-plugin-svelte": "^3.1.2",
+		"sass-embedded": "^1.77.8",
+		"svelte": "^4.2.7",
+		"svelte-check": "^3.6.0",
+		"tailwindcss": "3.4.9",
+		"typescript": "^5.0.0",
+		"typescript-eslint": "^8.0.0",
+		"vite": "^5.0.3",
+		"vite-plugin-tailwind-purgecss": "0.3.3"
+	},
+	"type": "module",
+	"dependencies": {
+		"@floating-ui/dom": "1.6.10",
+		"highlight.js": "11.10.0"
+	}
+}

sites/demo/postcss.config.cjs

@@ -0,0 +1,6 @@
+module.exports = {
+	plugins: {
+		tailwindcss: {},
+		autoprefixer: {}
+	}
+};

sites/demo/src/app.d.ts

@@ -0,0 +1,9 @@
+// See https://kit.svelte.dev/docs/types#app
+// for information about these interfaces
+// and what to do when importing types
+declare namespace App {
+	// interface Locals {}
+	// interface PageData {}
+	// interface Error {}
+	// interface Platform {}
+}

sites/demo/src/app.html

@@ -0,0 +1,12 @@
+<!doctype html>
+<html lang="en" class="dark">
+	<head>
+		<meta charset="utf-8" />
+		<link rel="icon" href="%sveltekit.assets%/favicon.png" />
+		<meta name="viewport" content="width=device-width" />
+		%sveltekit.head%
+	</head>
+	<body data-sveltekit-preload-data="hover" data-theme="wintry">
+		<div style="display: contents" class="h-full overflow-hidden">%sveltekit.body%</div>
+	</body>
+</html>

sites/demo/src/app.postcss

@@ -0,0 +1,9 @@
+@tailwind base;
+@tailwind components;
+@tailwind utilities;
+@tailwind variants;
+
+html,
+body {
+	@apply h-full overflow-hidden;
+}

sites/demo/src/lib/Navigation.svelte

@@ -0,0 +1,31 @@
+<script>
+	import { LightSwitch } from '@skeletonlabs/skeleton';
+
+	import { getDrawerStore } from '@skeletonlabs/skeleton';
+
+	const drawerStore = getDrawerStore();
+
+	const drawerClose = () => {
+		drawerStore.close();
+	};
+</script>
+
+<nav class="list-nav p-4">
+	<ul>
+		<li><a href="/" on:click={drawerClose}>Homepage</a></li>
+		<li>
+			<a href="https://twitter.com/j_igarashi" target="_blank" on:click={drawerClose}> Twitter </a>
+		</li>
+		<li>
+			<a href="https://github.com/watergis/maplibre-gl-sky" target="_blank" on:click={drawerClose}>
+				GitHub
+			</a>
+		</li>
+		<li>
+			<div class="flex items-center px-4">
+				<span class="pr-4">Light/Dark switch</span>
+				<span><LightSwitch /></span>
+			</div>
+		</li>
+	</ul>
+</nav>

sites/demo/src/routes/(demo)/+layout.svelte

@@ -0,0 +1,27 @@
+<script lang="ts">
+	import '../../app.postcss';
+</script>
+
+<svelte:head>
+	<link
+		rel="stylesheet"
+		href="https://cdnjs.cloudflare.com/ajax/libs/github-fork-ribbon-css/0.2.3/gh-fork-ribbon.min.css"
+	/>
+
+	<style>
+		html,
+		body {
+			padding: 0;
+			margin: 0;
+		}
+	</style>
+</svelte:head>
+
+<a
+	class="github-fork-ribbon left-top"
+	href="https://github.com/watergis/maplibre-gl-sky"
+	data-ribbon="Fork me on GitHub"
+	title="Fork me on GitHub">Fork me on GitHub</a
+>
+
+<slot />

sites/demo/src/routes/(demo)/maplibre/+page.svelte

@@ -0,0 +1,91 @@
+<script lang="ts">
+	import { Map, AttributionControl, NavigationControl, GeolocateControl } from 'maplibre-gl';
+	import { onMount } from 'svelte';
+	import 'maplibre-gl/dist/maplibre-gl.css';
+	import type { PageData } from './$types';
+	import {
+		AvailableTimeTypes,
+		SkyControl,
+		type AddToOptions,
+		type TimeType
+	} from '@watergis/maplibre-gl-sky';
+
+	export let data: PageData;
+
+	let map: Map;
+	let activeTime: TimeType | 'auto' = 'auto';
+
+	onMount(() => {
+		map = new Map({
+			container: 'map',
+			style: data.style,
+			maxPitch: 85,
+			hash: true,
+			attributionControl: false
+		});
+
+		map.addControl(new NavigationControl({ visualizePitch: true }), 'top-right');
+		map.addControl(new AttributionControl({ compact: false }), 'bottom-right');
+		map.addControl(
+			new GeolocateControl({
+				positionOptions: {
+					enableHighAccuracy: true
+				},
+				trackUserLocation: true
+			}),
+			'top-right'
+		);
+
+		initSky();
+	});
+
+	const initSky = (type?: TimeType) => {
+		if (!map) return;
+		const sky = new SkyControl();
+
+		let options: AddToOptions = {};
+		if (type) {
+			options.timeType = type;
+		}
+		activeTime = type ?? 'auto';
+		sky.addTo(map, options);
+	};
+</script>
+
+<div id="map" />
+
+<div class="overlay">
+	<div class="btn-group-vertical variant-filled">
+		<button
+			class="btn {activeTime === 'auto' ? 'variant-filled-primary' : ''} capitalize"
+			on:click={() => {
+				initSky();
+			}}>Auto</button
+		>
+		{#each AvailableTimeTypes as type}
+			<button
+				class="btn {activeTime === type ? 'variant-filled-primary' : ''} capitalize"
+				on:click={() => {
+					initSky(type);
+				}}>{type}</button
+			>
+		{/each}
+	</div>
+</div>
+
+<style lang="scss">
+	#map {
+		position: absolute;
+		top: 0;
+		bottom: 0;
+		width: 100%;
+		z-index: 10;
+	}
+
+	.overlay {
+		position: absolute;
+		bottom: 20px;
+		left: 10px;
+		z-index: 10;
+	}
+</style>