maplibre · m0nac0 · Nov 7, 2021 · Nov 7, 2021 · Nov 7, 2021 · Nov 7, 2021
diff --git a/.github/workflows/dart.yml b/.github/workflows/dart.yml
@@ -0,0 +1,31 @@
+name: Generate docs
+
+on:
+  push:
+      branches: [ main ]
+
+jobs:
+  generate-docs:
+    permissions: 
+      contents: write
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - uses: subosito/flutter-action@v1
+
+      - name: Install dartdoc
+        run: flutter pub global activate dartdoc
+
+      - name: Generate docs
+        run: flutter pub global run dartdoc
+
+      - name: Push docs
+        run: |
+          git config --global user.name "Docs Bot"
+          git config --global user.email "docs-bot-flutter-maplibre-gl@localhost"
+          git add -f doc
+          git commit -m "docs: ${{ github.event.commits[0].message }}"
+          git push
+
diff --git a/doc/api/__404error.html b/doc/api/__404error.html
@@ -0,0 +1,103 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="utf-8">
+  <meta http-equiv="X-UA-Compatible" content="IE=edge">
+  <meta name="viewport" content="width=device-width, height=device-height, initial-scale=1, user-scalable=no">
+  <meta name="generator" content="made with love by dartdoc 4.1.0">
+  <meta name="description" content="maplibre_gl API docs, for the Dart programming language.">
+  <title>maplibre_gl - Dart API docs</title>
+
+
+
+  <link rel="preconnect" href="https://fonts.gstatic.com">
+  <link href="https://fonts.googleapis.com/css2?family=Roboto+Mono:ital,wght@0,300;0,400;0,500;0,700;1,400&display=swap" rel="stylesheet">
+  <link href="https://fonts.googleapis.com/icon?family=Material+Icons" rel="stylesheet">
+
+  <link rel="stylesheet" href="static-assets/github.css?v1">
+  <link rel="stylesheet" href="static-assets/styles.css?v1">
+  <link rel="icon" href="static-assets/favicon.png?v1">
+
+
+</head>
+
+
+<body data-base-href=""
+      data-using-base-href="false">
+
+<div id="overlay-under-drawer"></div>
+
+<header id="title">
+  <button id="sidenav-left-toggle" type="button">&nbsp;</button>
+  <ol class="breadcrumbs gt-separated dark hidden-xs">
+    <li><a href="https://github.com/m0nac0/flutter-maplibre-gl">maplibre_gl package</a></li>
+  </ol>
+  <div class="self-name">maplibre_gl</div>
+  <form class="search navbar-right" role="search">
+    <input type="text" id="search-box" autocomplete="off" disabled class="form-control typeahead" placeholder="Loading search...">
+  </form>
+</header>
+
+<main>
+
+
+  <div id="dartdoc-main-content" class="main-content">
+    <h1>404: Something's gone wrong :-(</h1>
+
+    <section class="desc">
+      <p>You've tried to visit a page that doesn't exist.  Luckily this site
+         has other <a href="index.html">pages</a>.</p>
+      <p>If you were looking for something specific, try searching:
+      <form class="search-body" role="search">
+        <input type="text" id="search-body" autocomplete="off" disabled class="form-control typeahead" placeholder="Loading search...">
+      </form>
+      </p>
+
+    </section>
+  </div> <!-- /.main-content -->
+
+  <div id="dartdoc-sidebar-left" class="sidebar sidebar-offcanvas-left">
+    <header id="header-search-sidebar" class="hidden-l">
+  <form class="search-sidebar" role="search">
+    <input type="text" id="search-sidebar" autocomplete="off" disabled class="form-control typeahead" placeholder="Loading search...">
+  </form>
+</header>
+
+<ol class="breadcrumbs gt-separated dark hidden-l" id="sidebar-nav">
+  <li><a href="https://github.com/m0nac0/flutter-maplibre-gl">maplibre_gl package</a></li>
+</ol>
+
+
+    <h5><span class="package-name">maplibre_gl</span> <span class="package-kind">package</span></h5>
+    <ol>
+      <li class="section-title">Libraries</li>
+      <li><a href="maplibre_gl/maplibre_gl-library.html">maplibre_gl</a></li>
+</ol>
+
+  </div>
+
+  <div id="dartdoc-sidebar-right" class="sidebar sidebar-offcanvas-right">
+  </div>
+
+</main>
+
+<footer>
+  <span class="no-break">
+    maplibre_gl
+      0.15.0
+  </span>
+
+
+</footer>
+
+
+
+<script src="static-assets/highlight.pack.js?v1"></script>
+<script src="static-assets/script.js?v1"></script>
+
+
+
+</body>
+
+</html>
+
diff --git a/doc/api/categories.json b/doc/api/categories.json
@@ -0,0 +1 @@
+[]
diff --git a/doc/api/index.html b/doc/api/index.html
@@ -0,0 +1,193 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="utf-8">
+  <meta http-equiv="X-UA-Compatible" content="IE=edge">
+  <meta name="viewport" content="width=device-width, height=device-height, initial-scale=1, user-scalable=no">
+  <meta name="generator" content="made with love by dartdoc 4.1.0">
+  <meta name="description" content="maplibre_gl API docs, for the Dart programming language.">
+  <title>maplibre_gl - Dart API docs</title>
+
+
+
+  <link rel="preconnect" href="https://fonts.gstatic.com">
+  <link href="https://fonts.googleapis.com/css2?family=Roboto+Mono:ital,wght@0,300;0,400;0,500;0,700;1,400&display=swap" rel="stylesheet">
+  <link href="https://fonts.googleapis.com/icon?family=Material+Icons" rel="stylesheet">
+
+  <link rel="stylesheet" href="static-assets/github.css?v1">
+  <link rel="stylesheet" href="static-assets/styles.css?v1">
+  <link rel="icon" href="static-assets/favicon.png?v1">
+
+
+</head>
+
+
+<body data-base-href=""
+      data-using-base-href="false">
+
+<div id="overlay-under-drawer"></div>
+
+<header id="title">
+  <button id="sidenav-left-toggle" type="button">&nbsp;</button>
+  <ol class="breadcrumbs gt-separated dark hidden-xs">
+    <li><a href="https://github.com/m0nac0/flutter-maplibre-gl">maplibre_gl package</a></li>
+  </ol>
+  <div class="self-name">maplibre_gl</div>
+  <form class="search navbar-right" role="search">
+    <input type="text" id="search-box" autocomplete="off" disabled class="form-control typeahead" placeholder="Loading search...">
+  </form>
+</header>
+
+<main>
+
+
+  <div id="dartdoc-main-content" class="main-content">
+
+<section class="desc markdown">
+  <h1 id="flutter-maplibre-gl">Flutter Maplibre GL</h1>
+<p><a href="https://github.com/m0nac0/flutter-maplibre-gl/actions/workflows/flutter_ci.yml"><img src="https://github.com/m0nac0/flutter-maplibre-gl/actions/workflows/flutter_ci.yml/badge.svg" alt="Flutter CI"></a></p>
+<p>This Flutter plugin allows to show <strong>embedded interactive and customizable vector maps</strong> as a Flutter widget.</p>
+<p>For the Android and iOS integration, we use <a href="https://github.com/maplibre/maplibre-gl-native">maplibre-gl-native</a>. For web, we rely on <a href="https://github.com/maplibre/maplibre-gl-js">maplibre-gl-js</a>. This project only supports a subset of the API exposed by these libraries.</p>
+<p>This project is a fork of <a href="https://github.com/tobrun/flutter-mapbox-gl">https://github.com/tobrun/flutter-mapbox-gl</a>, replacing its usage of Mapbox GL libraries with the open source <a href="https://github.com/maplibre">Maplibre GL</a> libraries.</p>
+<p><strong>Please note that this project is community driven and is not affiliated with the company Mapbox.</strong> <br>
+It does use some of their amazing open source libraries/tools, though. Thank you, Mapbox, for all the open-source work you do!</p>
+<h2 id="using-the-plugin-in-your-project">Using the plugin in your project</h2>
+<p>This project is not yet available on pub.dev.
+You can use it by referencing it in your <code>pubspec.yaml</code> like this:</p>
+<pre class="language-yaml"><code class="language-yaml">dependencies:
+    ...
+    maplibre_gl:
+      git:
+        url: https://github.com/m0nac0/flutter-maplibre-gl.git
+        ref: main
+</code></pre>
+<p>This will get you the very latest changes from the main branch.
+You can replace <code>main</code> with the name of the <a href="https://github.com/m0nac0/flutter-maplibre-gl/releases">latest release</a>
+to get a well-tested version.</p>
+<p>Compared to flutter-mapbox-gl, the only breaking API changes are:</p>
+<ul>
+<li><code>MapboxMap</code> &lt;--&gt; <code>MaplibreMap</code></li>
+<li><code>MapboxMapController</code> &lt;--&gt; <code>MaplibreMapController</code></li>
+</ul>
+<h2 id="supported-api">Supported API</h2>
+<table><thead><tr><th>Feature</th><th style="text-align: center;">Android</th><th style="text-align: center;">iOS</th><th style="text-align: center;">Web</th></tr></thead><tbody><tr><td>Style</td><td style="text-align: center;">:white_check_mark:</td><td style="text-align: center;">:white_check_mark:</td><td style="text-align: center;">:white_check_mark:</td></tr><tr><td>Camera</td><td style="text-align: center;">:white_check_mark:</td><td style="text-align: center;">:white_check_mark:</td><td style="text-align: center;">:white_check_mark:</td></tr><tr><td>Gesture</td><td style="text-align: center;">:white_check_mark:</td><td style="text-align: center;">:white_check_mark:</td><td style="text-align: center;">:white_check_mark:</td></tr><tr><td>User Location</td><td style="text-align: center;">:white_check_mark:</td><td style="text-align: center;">:white_check_mark:</td><td style="text-align: center;">:white_check_mark:</td></tr><tr><td>Symbol</td><td style="text-align: center;">:white_check_mark:</td><td style="text-align: center;">:white_check_mark:</td><td style="text-align: center;">:white_check_mark:</td></tr><tr><td>Circle</td><td style="text-align: center;">:white_check_mark:</td><td style="text-align: center;">:white_check_mark:</td><td style="text-align: center;">:white_check_mark:</td></tr><tr><td>Line</td><td style="text-align: center;">:white_check_mark:</td><td style="text-align: center;">:white_check_mark:</td><td style="text-align: center;">:white_check_mark:</td></tr><tr><td>Fill</td><td style="text-align: center;">:white_check_mark:</td><td style="text-align: center;">:white_check_mark:</td><td style="text-align: center;">:white_check_mark:</td></tr></tbody></table>
+<h2 id="running-the-example-app">Running the example app</h2>
+<ul>
+<li>Install <a href="https://flutter.io/get-started/">Flutter</a> and validate its installation with <code>flutter doctor</code></li>
+<li>Clone the repository with <code>git clone git@github.com:m0nac0/flutter-maplibre-gl.git</code></li>
+<li>Connect a mobile device or start an emulator, simulator or chrome</li>
+<li>Run the app with <code>cd flutter-maplibre-gl/example &amp;&amp; flutter packages get &amp;&amp; flutter run</code></li>
+</ul>
+<h2 id="map-styles">Map Styles</h2>
+<p>Map styles can be supplied by setting the <code>styleString</code> in the <code>MapOptions</code>. The following formats are supported:</p>
+<ol>
+<li>Passing the URL of the map style. This should be a custom map style served remotely using a URL that start with 'http(s)://'</li>
+<li>Passing the style as a local asset. Create a JSON file in the <code>assets</code> and add a reference in <code>pubspec.yml</code>. Set the style string to the relative path for this asset in order to load it into the map.</li>
+<li>Passing the style as a local file. create an JSON file in app directory (e.g. ApplicationDocumentsDirectory). Set the style string to the absolute path of this JSON file.</li>
+<li>Passing the raw JSON of the map style. This is only supported on Android.</li>
+</ol>
+<h3 id="tile-sources-requiring-an-api-key">Tile sources requiring an API key</h3>
+<p>If your tile source requires an API key, we recomend directly specifying a source url with the API key included.
+For example:</p>
+<p><code>https://tiles.example.com/{z}/{x}/{y}.vector.pbf?api_key={your_key}</code></p>
+<h2 id="location-features">Location features</h2>
+<h3 id="android">Android</h3>
+<p>Add the <code>ACCESS_COARSE_LOCATION</code> or <code>ACCESS_FINE_LOCATION</code> permission in the application manifest <code>android/app/src/main/AndroidManifest.xml</code> to enable location features in an <strong>Android</strong> application:</p>
+<pre class="language-dart"><code>&lt;manifest ...
+    &lt;uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" /&gt;
+    &lt;uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" /&gt;
+</code></pre>
+<p>Starting from Android API level 23 you also need to request it at runtime. This plugin does not handle this for you. The example app uses the flutter <a href="https://pub.dev/packages/location">'location' plugin</a> for this.</p>
+<h3 id="ios">iOS</h3>
+<p>To enable location features in an <strong>iOS</strong> application:</p>
+<p>If you access your users' location, you should also add the following key to <code>ios/Runner/Info.plist</code> to explain why you need access to their location data:</p>
+<pre class="language-dart"><code>xml ...
+    &lt;key&gt;NSLocationWhenInUseUsageDescription&lt;/key&gt;
+    &lt;string&gt;[Your explanation here]&lt;/string&gt;
+</code></pre>
+<p>A possible explanation could be: "Shows your location on the map".</p>
+<h2 id="documentation">Documentation</h2>
+<p>This README file currently houses most of the documentation for this Flutter project. Please visit <a href="https://github.com/maplibre/maplibre-gl-js">https://github.com/maplibre/maplibre-gl-js</a> and <a href="https://github.com/maplibre/maplibre-gl-native">https://github.com/maplibre/maplibre-gl-native</a> for more information about the Maplibre libraries.</p>
+<h2 id="getting-help">Getting Help</h2>
+<ul>
+<li><strong>Need help with your code?</strong>: Check the <a href="https://github.com/m0nac0/flutter-maplibre-gl/discussions">discussions</a> on this repo or open a new one. 
+ Or look for previous questions on the <a href="https://stackoverflow.com/questions/tagged/maplibre">#maplibre tag</a> — or <a href="https://stackoverflow.com/questions/tagged/maplibre">ask a new question</a>.</li>
+<li><strong>Have a bug to report?</strong> <a href="https://github.com/m0nac0/flutter-maplibre-gl/issues/new">Open an issue</a>. If possible, include a full log and information which shows the issue.</li>
+<li><strong>Have a feature request?</strong> <a href="https://github.com/m0nac0/flutter-maplibre-gl/issues/new">Open an issue</a>. Tell us what the feature should do and why you want the feature.</li>
+</ul>
+<h2 id="avoid-android-unsatisfiedlinkerror">Avoid Android UnsatisfiedLinkError</h2>
+<p>Update buildTypes in <code>android\app\build.gradle</code></p>
+<pre class="language-gradle"><code class="language-gradle">buildTypes {
+    release {
+        // other configs
+        ndk {
+            abiFilters 'armeabi-v7a','arm64-v8a','x86_64', 'x86'
+        }
+    }
+}
+</code></pre>
+<h2 id="contributing">Contributing</h2>
+<p><a href="https://github.com/m0nac0/flutter-maplibre-gl/issues">Feedback</a> and contributions are very welcome!</p>
+</section>
+
+
+      <section class="summary">
+          <h2>Libraries</h2>
+        <dl>
+          <dt id="maplibre_gl">
+  <span class="name"><a href="maplibre_gl/maplibre_gl-library.html">maplibre_gl</a></span> 
+
+</dt>
+<dd> 
+</dd>
+
+        </dl>
+      </section>
+
+  </div> <!-- /.main-content -->
+
+  <div id="dartdoc-sidebar-left" class="sidebar sidebar-offcanvas-left">
+    <header id="header-search-sidebar" class="hidden-l">
+  <form class="search-sidebar" role="search">
+    <input type="text" id="search-sidebar" autocomplete="off" disabled class="form-control typeahead" placeholder="Loading search...">
+  </form>
+</header>
+
+<ol class="breadcrumbs gt-separated dark hidden-l" id="sidebar-nav">
+  <li><a href="https://github.com/m0nac0/flutter-maplibre-gl">maplibre_gl package</a></li>
+</ol>
+
+
+    <h5 class="hidden-xs"><span class="package-name">maplibre_gl</span> <span class="package-kind">package</span></h5>
+    <ol>
+      <li class="section-title">Libraries</li>
+      <li><a href="maplibre_gl/maplibre_gl-library.html">maplibre_gl</a></li>
+</ol>
+
+  </div>
+
+  <div id="dartdoc-sidebar-right" class="sidebar sidebar-offcanvas-right">
+  </div>
+
+</main>
+
+<footer>
+  <span class="no-break">
+    maplibre_gl
+      0.15.0
+  </span>
+
+
+</footer>
+
+
+
+<script src="static-assets/highlight.pack.js?v1"></script>
+<script src="static-assets/script.js?v1"></script>
+
+
+
+</body>
+
+</html>
+
diff --git a/doc/api/index.json b/doc/api/index.json