Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create mdbook documentation #681

Merged
merged 4 commits into from
May 29, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,4 @@ test_log*
pg_data/
config.yml
tests/output/
docs/book
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Collaborator Author

@sharkAndshark sharkAndshark May 27, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah. I didn't know this and enable it on vscode now. I'm trying to understand why it's important by google. Thx :D

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why its important to have last new line? Same reason as that we want trailing commas in a list, even though last comma is optional: if you make a change to the code, e.g. add one more line, you want the diff to only show one line change, not two

6 changes: 6 additions & 0 deletions docs/book.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
[book]
authors = ["Maplibre"]
language = "en"
multilingual = false
src = "src"
title = "Martin Documentation"
1 change: 1 addition & 0 deletions docs/src/API.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# API
1 change: 1 addition & 0 deletions docs/src/MBTile-and-PMTile-Sources.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# MBTile and PMTile Sources
1 change: 1 addition & 0 deletions docs/src/PostgreSQL-Connection-String.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# PostgreSQL Connection String
99 changes: 99 additions & 0 deletions docs/src/SUMMARY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,99 @@
# Summary

[Introduction](introduction.md)

# Requirements

- [Requirements](requirements.md)

# Installation

- [Installation](installation.md)

# Usage

- [Usage](usage.md)

# API

- [API](API.md)

# Using with MapLibre

- [Using with MapLibre](using-with-MapLibre.md)

# Using with Leaflet

- [Using with Leaflet](using-with-Leaflet.md)

# Using with deck.gl

- [Using with deck.gl](using-with-deck.gl.md)

# Using with Mapbox

- [Using with Mapbox](using-with-Mapbox.md)

# Source List

- [Source List](source-list.md)

# Table Sources

- [Table Sources](table-sources.md)

# Composite Sources

- [Composite Sources](composite-sources.md)

# Function Sources

- [Function Sources](function-Sources.md)

# MBTile and PMTile Sources

- [MBTile and PMTile Sources](MBTile-and-PMTile-Sources.md)

# Command-line Interface

- [Command-line Interface](command-line-Interface.md)

# Environment Variables

- [Environment Variables](environment-Variables.md)

# Configuration File

- [Configuration File](configuration-File.md)

# PostgreSQL Connection String

- [PostgreSQL Connection String](PostgreSQL-Connection-String.md)

# Using with Docker

- [Using with Docker](using-with-Docker.md)

# Using with Docker Compose

- [Using with Docker Compose](using-with-Docker-Compose.md)

# Using with Nginx

- [Using with Nginx](using-with-Nginx.md)

# Building from Source

- [Building from Source](building-from-Source.md)

# Debugging

- [Debugging](debugging.md)

# Development

- [Development](development.md)

# Recipes

- [Recipes](recipes.md)
1 change: 1 addition & 0 deletions docs/src/building-from-Source.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Building from Source
1 change: 1 addition & 0 deletions docs/src/command-line-Interface.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Command-line Interface
1 change: 1 addition & 0 deletions docs/src/composite-sources.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Composite Sources
1 change: 1 addition & 0 deletions docs/src/configuration-File.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Configuration File
1 change: 1 addition & 0 deletions docs/src/debugging.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Debugging
1 change: 1 addition & 0 deletions docs/src/development.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Development
1 change: 1 addition & 0 deletions docs/src/environment-Variables.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Environment Variables
1 change: 1 addition & 0 deletions docs/src/function-Sources.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Function Sources
1 change: 1 addition & 0 deletions docs/src/installation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Installation
1 change: 1 addition & 0 deletions docs/src/introduction.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Introduction
1 change: 1 addition & 0 deletions docs/src/recipes.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Recipes
1 change: 1 addition & 0 deletions docs/src/requirements.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Requirements
1 change: 1 addition & 0 deletions docs/src/source-list.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Source List
1 change: 1 addition & 0 deletions docs/src/table-sources.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Table Sources
1 change: 1 addition & 0 deletions docs/src/usage.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Usage
1 change: 1 addition & 0 deletions docs/src/using-with-Docker-Compose.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Using with Docker Compose
1 change: 1 addition & 0 deletions docs/src/using-with-Docker.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Using with Docker
1 change: 1 addition & 0 deletions docs/src/using-with-Leaflet.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Using with Leaflet
1 change: 1 addition & 0 deletions docs/src/using-with-MapLibre.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Using with MapLibre
1 change: 1 addition & 0 deletions docs/src/using-with-Mapbox.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Using with Mapbox
1 change: 1 addition & 0 deletions docs/src/using-with-Nginx.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Using with Nginx
1 change: 1 addition & 0 deletions docs/src/using-with-deck.gl.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Using with deck.gl