Skip to content

Commit 3da8257

Browse files
jarinoxJakob Stolze
jarinox
authored and
Jakob Stolze
committed
feat: add vitepress to render and serve docs
1 parent 67b4a53 commit 3da8257

File tree

4 files changed

+256
-0
lines changed

4 files changed

+256
-0
lines changed

‎.vitepress/config.mts

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
import { defineConfig } from 'vitepress'
2+
3+
// https://vitepress.dev/reference/site-config
4+
export default defineConfig({
5+
ignoreDeadLinks: true,
6+
title: "openrouteservice-py",
7+
description: "🐍 The Python API to consume openrouteservice(s) painlessly! ",
8+
base: '/openrouteservice-py/',
9+
head: [
10+
['link', { rel: "icon", type: "image/png", sizes: "32x32", href: "https://giscience.github.io/openrouteservice/ors_fav.png"}],
11+
],
12+
markdown: {
13+
anchor: {
14+
slugify: (s) => encodeURIComponent(String(s).trim().toLowerCase().replace(/\s+/g, '_'))
15+
},
16+
},
17+
vite: {
18+
publicDir: "./examples"
19+
},
20+
themeConfig: {
21+
search: {
22+
provider: 'local'
23+
},
24+
// https://vitepress.dev/reference/default-theme-config
25+
nav: [
26+
{ text: 'Home', link: '/' },
27+
{ text: 'Getting started', link: '/README' },
28+
{ text: 'Forum', link: 'https://ask.openrouteservice.org/c/sdks/10' },
29+
{ text: 'API Playground', link: 'https://openrouteservice.org/dev/#/api-docs' }
30+
],
31+
32+
sidebar: [
33+
{
34+
text: 'Documentation',
35+
link: 'README#documentation-for-api-endpoints',
36+
items: [
37+
{ text: 'Directions GeoJSON', link: '/docs/DirectionsServiceApi#get_geo_json_route' },
38+
{ text: 'Directions JSON', link: '/docs/DirectionsServiceApi#get_json_route' },
39+
{ text: 'Elevation Line', link: '/docs/ElevationApi#elevation_line_post' },
40+
{ text: 'Elevation Point', link: '/docs/ElevationApi#elevation_point_post' },
41+
{ text: 'Geocode Autocomplete ', link: '/docs/GeocodeApi#geocode_autocomplete_get' },
42+
{ text: 'Reverse Geocode', link: '/docs/GeocodeApi#geocode_reverse_get' },
43+
{ text: 'Forward Geocode', link: '/docs/GeocodeApi#geocode_search_get' },
44+
{ text: 'Structured Forward Geocode', link: '/docs/GeocodeApi#geocode_search_structured_get' },
45+
{ text: 'Isochrones', link: '/docs/IsochronesServiceApi#get_default_isochrones'},
46+
{ text: 'Matrix', link: '/docs/MatrixServiceApi#get_default' },
47+
{ text: 'Optimization', link: '/docs/OptimizationApi#optimization_post' },
48+
{ text: 'POIs', link: '/docs/PoisApi#pois_post' }
49+
]
50+
},
51+
{
52+
text: 'Examples',
53+
items: [
54+
{ text: 'Avoid construction sites dynamically', link: 'docs/examples/Avoid_ConstructionSites' },
55+
{ text: 'Dieselgate Routing', link: 'docs/examples/Dieselgate_Routing' },
56+
{ text: 'Route optimization of pub crawl', link: 'docs/examples/ortools_pubcrawl' },
57+
{ text: 'Routing optimization in humanitarian context', link: 'docs/examples/Routing_Optimization_Idai' }
58+
]
59+
},
60+
],
61+
62+
socialLinks: [
63+
{ icon: 'github', link: 'https://github.com/GIScience/openrouteservice-py' },
64+
{ icon: 'x', link: 'https://twitter.com/ors_news' }
65+
]
66+
}
67+
})

‎.vitepress/theme/custom.css

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
:root {
2+
--vp-c-brand-1: #b5152b;
3+
--vp-button-brand-bg: #b5152b;
4+
--vp-c-brand-2: #b5152b;
5+
/* values below are taken from the old Jekyll installation of the docs */
6+
--vp-font-family-base: "Open Sans", "Helvetica Neue", Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji";
7+
--vp-font-family-mono: "SFMono-Regular",menlo,consolas,monospace;
8+
9+
--vp-home-hero-name-color: transparent;
10+
--vp-home-hero-name-background: -webkit-linear-gradient(
11+
120deg,
12+
#b5152b 30%,
13+
#f57124
14+
);
15+
}
16+
17+
.vp-doc h1, .vp-doc h2, .vp-doc h3, .vp-doc h4, .vp-doc h5, .vp-doc h6 {
18+
font-weight: 300;
19+
}
20+
21+
/*
22+
//$body-font-family: "Open Sans", "Helvetica Neue", Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji";
23+
//$root-font-size: 14px; // Base font-size for rems
24+
//$font-size-8: 28px; //h1
25+
//
26+
//$body-background-color: #fbfcfd;
27+
//$code-background-color: #f7f7f7;
28+
//
29+
//$body-text-color: #5c5c5c;
30+
//$link-color: #d60039;
31+
//$border: 1px solid !default;
32+
//$border-color: #cfcfcf;
33+
*/

‎.vitepress/theme/index.ts

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
// https://vitepress.dev/guide/custom-theme
2+
import { h } from 'vue'
3+
import type { Theme } from 'vitepress'
4+
import DefaultTheme from 'vitepress/theme'
5+
import './custom.css'
6+
7+
export default {
8+
extends: DefaultTheme,
9+
Layout: () => {
10+
return h(DefaultTheme.Layout, null, {
11+
// https://vitepress.dev/guide/extending-default-theme#layout-slots
12+
})
13+
},
14+
enhanceApp({ app, router, siteData }) {
15+
// ...
16+
}
17+
} satisfies Theme

‎.vitepress/theme/style.css

Lines changed: 139 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,139 @@
1+
/**
2+
* Customize default theme styling by overriding CSS variables:
3+
* https://github.com/vuejs/vitepress/blob/main/src/client/theme-default/styles/vars.css
4+
*/
5+
6+
/**
7+
* Colors
8+
*
9+
* Each colors have exact same color scale system with 3 levels of solid
10+
* colors with different brightness, and 1 soft color.
11+
*
12+
* - `XXX-1`: The most solid color used mainly for colored text. It must
13+
* satisfy the contrast ratio against when used on top of `XXX-soft`.
14+
*
15+
* - `XXX-2`: The color used mainly for hover state of the button.
16+
*
17+
* - `XXX-3`: The color for solid background, such as bg color of the button.
18+
* It must satisfy the contrast ratio with pure white (#ffffff) text on
19+
* top of it.
20+
*
21+
* - `XXX-soft`: The color used for subtle background such as custom container
22+
* or badges. It must satisfy the contrast ratio when putting `XXX-1` colors
23+
* on top of it.
24+
*
25+
* The soft color must be semi transparent alpha channel. This is crucial
26+
* because it allows adding multiple "soft" colors on top of each other
27+
* to create a accent, such as when having inline code block inside
28+
* custom containers.
29+
*
30+
* - `default`: The color used purely for subtle indication without any
31+
* special meanings attched to it such as bg color for menu hover state.
32+
*
33+
* - `brand`: Used for primary brand colors, such as link text, button with
34+
* brand theme, etc.
35+
*
36+
* - `tip`: Used to indicate useful information. The default theme uses the
37+
* brand color for this by default.
38+
*
39+
* - `warning`: Used to indicate warning to the users. Used in custom
40+
* container, badges, etc.
41+
*
42+
* - `danger`: Used to show error, or dangerous message to the users. Used
43+
* in custom container, badges, etc.
44+
* -------------------------------------------------------------------------- */
45+
46+
:root {
47+
--vp-c-default-1: var(--vp-c-gray-1);
48+
--vp-c-default-2: var(--vp-c-gray-2);
49+
--vp-c-default-3: var(--vp-c-gray-3);
50+
--vp-c-default-soft: var(--vp-c-gray-soft);
51+
52+
--vp-c-brand-1: var(--vp-c-indigo-1);
53+
--vp-c-brand-2: var(--vp-c-indigo-2);
54+
--vp-c-brand-3: var(--vp-c-indigo-3);
55+
--vp-c-brand-soft: var(--vp-c-indigo-soft);
56+
57+
--vp-c-tip-1: var(--vp-c-brand-1);
58+
--vp-c-tip-2: var(--vp-c-brand-2);
59+
--vp-c-tip-3: var(--vp-c-brand-3);
60+
--vp-c-tip-soft: var(--vp-c-brand-soft);
61+
62+
--vp-c-warning-1: var(--vp-c-yellow-1);
63+
--vp-c-warning-2: var(--vp-c-yellow-2);
64+
--vp-c-warning-3: var(--vp-c-yellow-3);
65+
--vp-c-warning-soft: var(--vp-c-yellow-soft);
66+
67+
--vp-c-danger-1: var(--vp-c-red-1);
68+
--vp-c-danger-2: var(--vp-c-red-2);
69+
--vp-c-danger-3: var(--vp-c-red-3);
70+
--vp-c-danger-soft: var(--vp-c-red-soft);
71+
}
72+
73+
/**
74+
* Component: Button
75+
* -------------------------------------------------------------------------- */
76+
77+
:root {
78+
--vp-button-brand-border: transparent;
79+
--vp-button-brand-text: var(--vp-c-white);
80+
--vp-button-brand-bg: var(--vp-c-brand-3);
81+
--vp-button-brand-hover-border: transparent;
82+
--vp-button-brand-hover-text: var(--vp-c-white);
83+
--vp-button-brand-hover-bg: var(--vp-c-brand-2);
84+
--vp-button-brand-active-border: transparent;
85+
--vp-button-brand-active-text: var(--vp-c-white);
86+
--vp-button-brand-active-bg: var(--vp-c-brand-1);
87+
}
88+
89+
/**
90+
* Component: Home
91+
* -------------------------------------------------------------------------- */
92+
93+
:root {
94+
--vp-home-hero-name-color: transparent;
95+
--vp-home-hero-name-background: -webkit-linear-gradient(
96+
120deg,
97+
#bd34fe 30%,
98+
#41d1ff
99+
);
100+
101+
--vp-home-hero-image-background-image: linear-gradient(
102+
-45deg,
103+
#bd34fe 50%,
104+
#47caff 50%
105+
);
106+
--vp-home-hero-image-filter: blur(44px);
107+
}
108+
109+
@media (min-width: 640px) {
110+
:root {
111+
--vp-home-hero-image-filter: blur(56px);
112+
}
113+
}
114+
115+
@media (min-width: 960px) {
116+
:root {
117+
--vp-home-hero-image-filter: blur(68px);
118+
}
119+
}
120+
121+
/**
122+
* Component: Custom Block
123+
* -------------------------------------------------------------------------- */
124+
125+
:root {
126+
--vp-custom-block-tip-border: transparent;
127+
--vp-custom-block-tip-text: var(--vp-c-text-1);
128+
--vp-custom-block-tip-bg: var(--vp-c-brand-soft);
129+
--vp-custom-block-tip-code-bg: var(--vp-c-brand-soft);
130+
}
131+
132+
/**
133+
* Component: Algolia
134+
* -------------------------------------------------------------------------- */
135+
136+
.DocSearch {
137+
--docsearch-primary-color: var(--vp-c-brand-1) !important;
138+
}
139+

0 commit comments

Comments
 (0)