mirror of
https://github.com/marceloprates/prettymaps.git
synced 2025-08-31 02:00:16 +02:00
deploy: 20858a6f58
This commit is contained in:
marceloprates
5717
api/index.html
5717
api/index.html
File diff suppressed because it is too large
Load Diff
94
index.html
94
index.html
@@ -213,6 +213,19 @@
|
||||
|
||||
|
||||
|
||||
<label class="md-nav__link md-nav__link--active" for="__toc">
|
||||
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Home
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
<span class="md-nav__icon md-icon"></span>
|
||||
</label>
|
||||
|
||||
<a href="." class="md-nav__link md-nav__link--active">
|
||||
|
||||
|
||||
@@ -225,6 +238,43 @@
|
||||
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<label class="md-nav__title" for="__toc">
|
||||
<span class="md-nav__icon md-icon"></span>
|
||||
Table of contents
|
||||
</label>
|
||||
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#features" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
Features
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#quick-example" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
Quick Example
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
|
||||
</nav>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
@@ -293,6 +343,32 @@
|
||||
|
||||
|
||||
|
||||
<label class="md-nav__title" for="__toc">
|
||||
<span class="md-nav__icon md-icon"></span>
|
||||
Table of contents
|
||||
</label>
|
||||
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#features" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
Features
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#quick-example" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
Quick Example
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
@@ -308,7 +384,23 @@
|
||||
|
||||
|
||||
<h1 id="prettymaps-documentation">Prettymaps Documentation</h1>
|
||||
<p>Welcome to the Prettymaps documentation site. </p>
|
||||
<p>Welcome to the Prettymaps documentation site.</p>
|
||||
<p>Prettymaps is a minimal Python library to draw beautiful maps from OpenStreetMap data.<br />
|
||||
It allows you to easily generate artistic, customizable maps for any location in the world.</p>
|
||||
<h2 id="features">Features</h2>
|
||||
<ul>
|
||||
<li>Fetches and visualizes OpenStreetMap data with minimal code</li>
|
||||
<li>Highly customizable layers and styles</li>
|
||||
<li>Supports elevation, hillshading, and keypoints</li>
|
||||
<li>Preset system for reusable map styles</li>
|
||||
<li>Export to PNG, SVG, and plotter-friendly formats</li>
|
||||
</ul>
|
||||
<h2 id="quick-example">Quick Example</h2>
|
||||
<pre><code class="language-python">import prettymaps
|
||||
|
||||
prettymaps.plot("Porto Alegre, Brazil")
|
||||
</code></pre>
|
||||
<p>Explore the <a href="usage/">Usage</a> and <a href="api/">API Reference</a> for more details. </p>
|
||||
|
||||
|
||||
|
||||
|
||||
BIN
objects.inv
BIN
objects.inv
Binary file not shown.
File diff suppressed because one or more lines are too long
169
usage/index.html
169
usage/index.html
@@ -237,6 +237,19 @@
|
||||
|
||||
|
||||
|
||||
<label class="md-nav__link md-nav__link--active" for="__toc">
|
||||
|
||||
|
||||
|
||||
<span class="md-ellipsis">
|
||||
Usage
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
<span class="md-nav__icon md-icon"></span>
|
||||
</label>
|
||||
|
||||
<a href="./" class="md-nav__link md-nav__link--active">
|
||||
|
||||
|
||||
@@ -249,6 +262,70 @@
|
||||
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<label class="md-nav__title" for="__toc">
|
||||
<span class="md-nav__icon md-icon"></span>
|
||||
Table of contents
|
||||
</label>
|
||||
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#installation" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
Installation
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#basic-usage" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
Basic Usage
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#customizing-layers-and-styles" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
Customizing Layers and Styles
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#saving-maps" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
Saving Maps
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#advanced-features" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
Advanced Features
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
|
||||
</nav>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
@@ -295,6 +372,59 @@
|
||||
|
||||
|
||||
|
||||
<label class="md-nav__title" for="__toc">
|
||||
<span class="md-nav__icon md-icon"></span>
|
||||
Table of contents
|
||||
</label>
|
||||
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#installation" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
Installation
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#basic-usage" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
Basic Usage
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#customizing-layers-and-styles" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
Customizing Layers and Styles
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#saving-maps" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
Saving Maps
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#advanced-features" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
Advanced Features
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
@@ -310,8 +440,43 @@
|
||||
|
||||
|
||||
<h1 id="usage">Usage</h1>
|
||||
<p>This page will describe how to use Prettymaps.</p>
|
||||
<p><em>More details coming soon!</em> </p>
|
||||
<h2 id="installation">Installation</h2>
|
||||
<p>Install Prettymaps and its dependencies:</p>
|
||||
<pre><code class="language-sh">pip install prettymaps
|
||||
</code></pre>
|
||||
<h2 id="basic-usage">Basic Usage</h2>
|
||||
<p>Generate a map for a location:</p>
|
||||
<pre><code class="language-python">import prettymaps
|
||||
|
||||
prettymaps.plot("Paris, France")
|
||||
</code></pre>
|
||||
<h2 id="customizing-layers-and-styles">Customizing Layers and Styles</h2>
|
||||
<p>You can customize which map layers to show and their appearance:</p>
|
||||
<pre><code class="language-python">layers = {
|
||||
"perimeter": {},
|
||||
"streets": {"width": 8},
|
||||
"buildings": {},
|
||||
"water": {},
|
||||
}
|
||||
style = {
|
||||
"perimeter": {"fc": "#f2efe9", "ec": "#333"},
|
||||
"streets": {"fc": "#cccccc"},
|
||||
"buildings": {"fc": "#b0b0b0"},
|
||||
"water": {"fc": "#aadaff"},
|
||||
}
|
||||
prettymaps.plot("Berlin, Germany", layers=layers, style=style)
|
||||
</code></pre>
|
||||
<h2 id="saving-maps">Saving Maps</h2>
|
||||
<p>You can save the generated map to a file:</p>
|
||||
<pre><code class="language-python">prettymaps.plot("Tokyo, Japan", save_as="tokyo_map.png")
|
||||
</code></pre>
|
||||
<h2 id="advanced-features">Advanced Features</h2>
|
||||
<ul>
|
||||
<li><strong>Keypoints:</strong> Highlight specific places or features on the map.</li>
|
||||
<li><strong>Presets:</strong> Save and reuse your favorite map styles.</li>
|
||||
<li><strong>Hillshade:</strong> Add elevation shading for a 3D effect.</li>
|
||||
</ul>
|
||||
<p>See the <a href="../api/">API Reference</a> for all available options. </p>
|
||||
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user