From f39f9f1b138f6dae7ce4f05f75630903ba7a4d9d Mon Sep 17 00:00:00 2001 From: Luka S <58115698+JaffaKetchup@users.noreply.github.com> Date: Wed, 28 Jul 2021 13:24:00 +0100 Subject: [PATCH 1/3] Set theme jekyll-theme-cayman --- docs/_config.yml | 1 + docs/index.md | 37 +++++++++++++++++++++++++++++++++++++ 2 files changed, 38 insertions(+) create mode 100644 docs/_config.yml create mode 100644 docs/index.md diff --git a/docs/_config.yml b/docs/_config.yml new file mode 100644 index 000000000..c4192631f --- /dev/null +++ b/docs/_config.yml @@ -0,0 +1 @@ +theme: jekyll-theme-cayman \ No newline at end of file diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 000000000..1daffe29d --- /dev/null +++ b/docs/index.md @@ -0,0 +1,37 @@ +## Welcome to GitHub Pages + +You can use the [editor on GitHub](https://github.com/JaffaKetchup/flutter_map/edit/documentation/docs/index.md) to maintain and preview the content for your website in Markdown files. + +Whenever you commit to this repository, GitHub Pages will run [Jekyll](https://jekyllrb.com/) to rebuild the pages in your site, from the content in your Markdown files. + +### Markdown + +Markdown is a lightweight and easy-to-use syntax for styling your writing. It includes conventions for + +```markdown +Syntax highlighted code block + +# Header 1 +## Header 2 +### Header 3 + +- Bulleted +- List + +1. Numbered +2. List + +**Bold** and _Italic_ and `Code` text + +[Link](url) and ![Image](src) +``` + +For more details see [GitHub Flavored Markdown](https://guides.github.com/features/mastering-markdown/). + +### Jekyll Themes + +Your Pages site will use the layout and styles from the Jekyll theme you have selected in your [repository settings](https://github.com/JaffaKetchup/flutter_map/settings/pages). The name of this theme is saved in the Jekyll `_config.yml` configuration file. + +### Support or Contact + +Having trouble with Pages? Check out our [documentation](https://docs.github.com/categories/github-pages-basics/) or [contact support](https://support.github.com/contact) and we’ll help you sort it out. From 96a969381d2f0596ea1d28b2f9d336e2003f39c9 Mon Sep 17 00:00:00 2001 From: Luka S <58115698+JaffaKetchup@users.noreply.github.com> Date: Wed, 28 Jul 2021 13:24:04 +0100 Subject: [PATCH 2/3] Create index.md From 9060b734dac761b0b598f292fa6a570d707f47c2 Mon Sep 17 00:00:00 2001 From: Luka S Date: Wed, 28 Jul 2021 14:56:22 +0100 Subject: [PATCH 3/3] Initial Commit --- docs/_config.yml | 4 +++- docs/go.md | 3 +++ docs/index.md | 47 ++++++++++++++++++++++++++--------------------- 3 files changed, 32 insertions(+), 22 deletions(-) create mode 100644 docs/go.md diff --git a/docs/_config.yml b/docs/_config.yml index c4192631f..45ad5e60d 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -1 +1,3 @@ -theme: jekyll-theme-cayman \ No newline at end of file +theme: jekyll-theme-cayman +title: flutter_map Documentation +description: A port of leaflet.js for Flutter diff --git a/docs/go.md b/docs/go.md new file mode 100644 index 000000000..7c45bd520 --- /dev/null +++ b/docs/go.md @@ -0,0 +1,3 @@ +## Make Your First Map + +s \ No newline at end of file diff --git a/docs/index.md b/docs/index.md index 1daffe29d..d1d9ef65e 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,37 +1,42 @@ -## Welcome to GitHub Pages +## flutter_map Documentation -You can use the [editor on GitHub](https://github.com/JaffaKetchup/flutter_map/edit/documentation/docs/index.md) to maintain and preview the content for your website in Markdown files. +> #### UNOFFICIAL DOCUMENTATION AHEAD +> +> This documentation is not official and has not been verified or influenced by maintainers of `flutter_map`. For all documentation, use the official README at https://github.com/fleaflet/flutter_map. -Whenever you commit to this repository, GitHub Pages will run [Jekyll](https://jekyllrb.com/) to rebuild the pages in your site, from the content in your Markdown files. +`flutter_map` is a mapping package for Flutter, based off 'leaflet.js'. Simple and easy to learn, yet completely customizable and configurable, it's the best choice for Flutter if Google Maps isn't your target map. -### Markdown +[![Pub](https://img.shields.io/pub/v/flutter_map.svg)](https://pub.dev/packages/flutter_map) [![likes](https://badges.bar/flutter_map/likes)](https://pub.dev/packages/flutter_map/score) [![pub points](https://badges.bar/flutter_map/pub%20points)](https://pub.dev/packages/flutter_map/score) +[![CI](https://github.com/fleaflet/flutter_map/workflows/Tests/badge.svg?)](https://github.com/fleaflet/flutter_map/actions?query=branch%3Amaster) [![GitHub stars](https://img.shields.io/github/stars/fleaflet/flutter_map.svg?label=Stars)](https://GitHub.com/fleaflet/flutter_map/stargazers/) [![GitHub issues](https://img.shields.io/github/issues/fleaflet/flutter_map.svg?label=Issues)](https://GitHub.com/fleaflet/flutter_map/issues/) [![GitHub PRs](https://img.shields.io/github/issues-pr/fleaflet/flutter_map.svg?label=Pull%20Requests)](https://GitHub.com/fleaflet/flutter_map/pulls/) -Markdown is a lightweight and easy-to-use syntax for styling your writing. It includes conventions for +### Getting Started -```markdown -Syntax highlighted code block +Installing this package is easy, and uses the normal installation method: -# Header 1 -## Header 2 -### Header 3 +```shell + > flutter pub add flutter_map +``` -- Bulleted -- List +If you urgently need the most recent version of this package that hasn't been published to pub.dev yet, use this code snippet instead in your 'pubspec.yaml' (please note that this method is not recommended): -1. Numbered -2. List +```yaml +flutter_map: + git: + url: https://github.com/fleaflet/flutter_map.git +``` -**Bold** and _Italic_ and `Code` text +On Android, you'll also need to configure your app to access the Internet. Add the following line to the manifest file located in '/android/app/src/main/AndroidManifest.xml': -[Link](url) and ![Image](src) +```xml + ``` -For more details see [GitHub Flavored Markdown](https://guides.github.com/features/mastering-markdown/). +After installing the package, import it into the necessary files in your project: -### Jekyll Themes - -Your Pages site will use the layout and styles from the Jekyll theme you have selected in your [repository settings](https://github.com/JaffaKetchup/flutter_map/settings/pages). The name of this theme is saved in the Jekyll `_config.yml` configuration file. +```dart +import 'package:flutter_map/flutter_map.dart'; +``` ### Support or Contact -Having trouble with Pages? Check out our [documentation](https://docs.github.com/categories/github-pages-basics/) or [contact support](https://support.github.com/contact) and we’ll help you sort it out. +Having trouble with `flutter_map`? Visit [StackOverflow](https://stackoverflow.com/search?q=flutter_map) or the [GitHub Issue Tracker](https://github.com/fleaflet/flutter_map/issues), and ask away! The community will try to get back to you as soon as possible.