Skip to content

Commit

Permalink
change landing page to docs page
Browse files Browse the repository at this point in the history
  • Loading branch information
bdon committed Oct 4, 2023
1 parent b532a6a commit 58f39fd
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 36 deletions.
4 changes: 2 additions & 2 deletions .vitepress/config.mts
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ export default defineConfig({
logo: '/logo.svg',
// https://vitepress.dev/reference/default-theme-config
nav: [
{ text: 'Guides', link: '/guide/what-is-protomaps' },
{ text: 'Guides', link: '/' },
{ text: 'protomaps.com', link: 'https://protomaps.com' },
{ text: 'Sponsor on GitHub', link: 'https://github.com/sponsors/protomaps' }
],
Expand All @@ -18,7 +18,7 @@ export default defineConfig({
text: 'Introduction',
collapsed: true,
items: [
{ text: 'What is Protomaps?', link: '/guide/what-is-protomaps' },
{ text: 'What is Protomaps?', link: '/' },
{ text: 'Getting Started', link: '/guide/getting-started' }
]
},
Expand Down
8 changes: 0 additions & 8 deletions guide/what-is-protomaps.md

This file was deleted.

49 changes: 23 additions & 26 deletions index.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,26 @@
---
# https://vitepress.dev/reference/default-theme-home-page
layout: home

hero:
name: "Protomaps Docs"
text: "Under Construction"
tagline: Technical documentation for the open source Protomaps ecosystem
actions:
- theme: brand
text: What is Protomaps?
link: /guide/what-is-protomaps
- theme: alt
text: Getting Started
link: /guide/getting-started

features:
- title: Simple deployment
details: A serverless deployment using static single-files.
- title: Feature B
details: Lorem ipsum dolor sit amet, consectetur adipiscing elit
- title: Feature C
details: Lorem ipsum dolor sit amet, consectetur adipiscing elit
- title: Feature C
details: Lorem ipsum dolor sit amet, consectetur adipiscing elit
- title: Feature C
details: Lorem ipsum dolor sit amet, consectetur adipiscing elit
title: Protomaps Documentation
outline: deep
---

<script setup>
import MaplibreMap from './components/MaplibreMap.vue'
</script>

# Protomaps

Protomaps is an open source system for interactive web maps, like this one:

<MaplibreMap/>

There are three major parts of Protomaps:

* **PMTiles**, an open archive format for pyramids of tile data, accessible via [HTTP Range Requests](https://developer.mozilla.org/en-US/docs/Web/HTTP/Range_requests).
* An **ecosystem of tools and libraries** for creating, serving and manipulating PMTiles.
* A **cartographic "basemap"** showing features in the world like roads, water bodies and labels, based on the OpenStreetMap dataset, and delivered as one big PMTiles archive.

Each of these parts has a corresponding section in the documentation.

If it's your first time trying Protomaps, the [Getting Started](/guide/getting-started) guide will demonstrate all parts of the system.


0 comments on commit 58f39fd

Please sign in to comment.