Skip to content

Latest commit

 

History

History
 
 

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 

README.md

Geocoding.net Documentation

This folder contains the VitePress documentation site for Geocoding.net.

Prerequisites

  • Node.js 20.19.x LTS or 22.12+
  • npm

Getting Started

Install dependencies from the docs/ directory:

npm ci

Start the development server:

npm run dev

Build the static site:

npm run build

Preview the built site locally:

npm run preview

Structure

docs/
β”œβ”€β”€ .vitepress/
β”‚   └── config.ts
β”œβ”€β”€ guide/
β”‚   β”œβ”€β”€ getting-started.md
β”‚   β”œβ”€β”€ providers/
β”‚   β”‚   β”œβ”€β”€ azure-maps.md
β”‚   β”‚   β”œβ”€β”€ bing-maps.md
β”‚   β”‚   β”œβ”€β”€ google.md
β”‚   β”‚   β”œβ”€β”€ here.md
β”‚   β”‚   β”œβ”€β”€ mapquest.md
β”‚   β”‚   └── yahoo.md
β”‚   β”œβ”€β”€ providers.md
β”‚   β”œβ”€β”€ sample-app.md
β”‚   └── what-is-geocoding-net.md
β”œβ”€β”€ index.md
β”œβ”€β”€ package-lock.json
β”œβ”€β”€ package.json
└── README.md

Notes

  • guide/ contains the published consumer and contributor documentation.
  • Keep README.md, AGENTS.md, and the guide pages aligned when provider support or contributor workflows change.