-
Notifications
You must be signed in to change notification settings - Fork 416
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
57 changed files
with
1,902 additions
and
552 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,66 @@ | ||
| # Sample workflow for building and deploying a VitePress site to GitHub Pages | ||
| # | ||
| name: Deploy Backend Documentation to Pages | ||
|
|
||
| on: | ||
| # Runs on pushes targeting the `main` branch. Change this to `master` if you're | ||
| # using the `master` branch as the default branch. | ||
| push: | ||
| branches: [master] | ||
|
|
||
| # Allows you to run this workflow manually from the Actions tab | ||
| workflow_dispatch: | ||
|
|
||
| # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages | ||
| permissions: | ||
| contents: read | ||
| pages: write | ||
| id-token: write | ||
|
|
||
| # Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued. | ||
| # However, do NOT cancel in-progress runs as we want to allow these production deployments to complete. | ||
| concurrency: | ||
| group: pages | ||
| cancel-in-progress: false | ||
|
|
||
| jobs: | ||
| # Build job | ||
| build: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Checkout | ||
| uses: actions/checkout@v3 | ||
| with: | ||
| fetch-depth: 0 # Not needed if lastUpdated is not enabled | ||
| # - uses: pnpm/action-setup@v2 # Uncomment this if you're using pnpm | ||
| # - uses: oven-sh/setup-bun@v1 # Uncomment this if you're using Bun | ||
| - name: Setup Node | ||
| uses: actions/setup-node@v3 | ||
| with: | ||
| node-version: 20 | ||
| cache: npm # or pnpm / yarn | ||
| - name: Setup Pages | ||
| uses: actions/configure-pages@v3 | ||
| - name: Install dependencies | ||
| run: npm ci # or pnpm install / yarn install / bun install | ||
| - name: Build with VitePress | ||
| run: | | ||
| npm run docs:build # or pnpm docs:build / yarn docs:build / bun run docs:build | ||
| touch docs/.vitepress/dist/.nojekyll | ||
| - name: Upload artifact | ||
| uses: actions/upload-pages-artifact@v2 | ||
| with: | ||
| path: docs/.vitepress/dist | ||
|
|
||
| # Deployment job | ||
| deploy: | ||
| environment: | ||
| name: github-pages | ||
| url: ${{ steps.deployment.outputs.page_url }} | ||
| needs: build | ||
| runs-on: ubuntu-latest | ||
| name: Deploy | ||
| steps: | ||
| - name: Deploy to GitHub Pages | ||
| id: deployment | ||
| uses: actions/deploy-pages@v2 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,122 @@ | ||
| import {defineConfig} from 'vitepress' | ||
|
|
||
| // https://vitepress.dev/reference/site-config | ||
| export default defineConfig({ | ||
| title: "openrouteservice backend documentation", | ||
| description: "openrouteservice backend documentation", | ||
| base: "/openrouteservice/", | ||
| head: [['link', {rel: 'icon', href: '/openrouteservice/ors_fav.png'}]], | ||
| cleanUrls: true, | ||
| themeConfig: { | ||
| // https://vitepress.dev/reference/default-theme-config | ||
| siteTitle: false, | ||
| logo: { | ||
| light: '/openrouteservice.png', | ||
| dark: '/openrouteservice_dark.png', | ||
| alt: 'openrouteservice logo' | ||
| }, | ||
| search: { | ||
| provider: 'local' | ||
| }, | ||
| outline: { | ||
| level: [2, 4] | ||
| }, | ||
| lastUpdated: { | ||
| text: 'Updated at', | ||
| formatOptions: { | ||
| dateStyle: 'medium', | ||
| timeStyle: 'short' | ||
| } | ||
| }, | ||
| editLink: { | ||
| pattern: 'https://github.com/GIScience/openrouteservice/issues/new?labels=documentation+%3Abook%3A&template=docs.yml', | ||
| text: 'Suggest an improvement' | ||
| }, | ||
| nav: [ | ||
| {text: 'Homepage', link: 'https://openrouteservice.org'}, | ||
| {text: 'Forum', link: 'https://ask.openrouteservice.org'}, | ||
| {text: 'API Playground', link: 'https://openrouteservice.org/dev/#/api-docs'}, | ||
| ], | ||
| sidebar: [ | ||
| { | ||
| text: 'Home', link: '/', | ||
| items: [ | ||
| {text: 'Getting Started', link: '/getting-started'}, | ||
| { | ||
| text: 'Installation and Usage', collapsed: true, link: '/installation/Installation-and-Usage', | ||
| items: [ | ||
| {text: 'Running with Docker', link: '/installation/Running-with-Docker'}, | ||
| {text: 'Building from Source', link: '/installation/Building-from-Source'}, | ||
| {text: 'System Requirements', link: '/installation/System-Requirements'}, | ||
| {text: 'Configuration', link: '/installation/Configuration'}, | ||
| {text: 'Advanced Docker Setup', link: '/installation/Advanced-Docker-Setup'}, | ||
| {text: 'Backend Documentation', link: '/installation/Backend-Documentation'} | ||
| ] | ||
| }, | ||
| {text: 'Data', link: '/Data'}, | ||
| { | ||
| text: 'Contributing', collapsed: true, link: '/contributing/Contributing', | ||
| items: [ | ||
| {text: 'Contributing Translations', link: '/contributing/Contributing-Translations'} | ||
| ] | ||
| }, | ||
| { | ||
| text: 'Documentation', collapsed: true, link: '/documentation/Documentation', | ||
| items: [ | ||
| {text: 'Tag Filtering', link: '/documentation/Tag-Filtering'}, | ||
| { | ||
| text: 'Travel Speeds', | ||
| collapsed: true, | ||
| link: '/documentation/travel-speeds/Travel-Speeds', | ||
| items: [ | ||
| {text: 'Waytype Speeds', link: '/documentation/travel-speeds/Waytype-Speeds'}, | ||
| {text: 'Surface Speeds', link: '/documentation/travel-speeds/Surface-Speeds'}, | ||
| {text: 'Tracktype Speeds', link: '/documentation/travel-speeds/Tracktype-Speeds'}, | ||
| {text: 'Country Speeds', link: '/documentation/travel-speeds/Country-Speeds'} | ||
| ] | ||
| }, | ||
| {text: 'Route Attributes', link: '/documentation/Route-Attributes'}, | ||
| { | ||
| text: 'Routing Options', | ||
| collapsed: true, | ||
| link: '/documentation/routing-options/Routing-Options', | ||
| items: [ | ||
| {text: 'Examples', link: '/documentation/routing-options/Examples'}, | ||
| {text: 'Country List', link: '/documentation/routing-options/Country-List'}, | ||
| ] | ||
| }, | ||
| {text: 'Instruction Types', link: '/documentation/Instruction-Types'}, | ||
| { | ||
| text: 'Extra Info', collapsed: true, link: '/documentation/extra-info/Extra-Info', | ||
| items: [ | ||
| {text: 'Steepness', link: '/documentation/extra-info/Steepness'}, | ||
| {text: 'Surface', link: '/documentation/extra-info/Surface'}, | ||
| {text: 'Waycategory', link: '/documentation/extra-info/Waycategory'}, | ||
| {text: 'Waytype', link: '/documentation/extra-info/Waytype'}, | ||
| {text: 'Trail Difficulty', link: '/documentation/extra-info/Trail-Difficulty'}, | ||
| { | ||
| text: 'Road Access Restrictions', | ||
| link: '/documentation/extra-info/Road-Access-Restrictions' | ||
| } | ||
| ] | ||
| }, | ||
| {text: 'Geometry Decoding', link: '/documentation/Geometry-Decoding'}, | ||
| {text: 'Structured Geocoding Query', link: '/documentation/Structured-Geocoding-Query'}, | ||
| {text: 'Matrix Response', link: '/documentation/Matrix-Response'}, | ||
| {text: 'Places Request and Response', link: '/documentation/Places-Request-and-Response'}, | ||
| {text: 'Geocoding Response', link: '/documentation/Geocoding-Response'}, | ||
| {text: 'Error Codes', link: '/documentation/Error-Codes'}, | ||
| ] | ||
| }, | ||
| {text: 'FAQ', link: '/Frequently-Asked-Questions'} | ||
| ] | ||
| } | ||
| ], | ||
| socialLinks: [ | ||
| {icon: 'github', link: 'https://github.com/GIScience/openrouteservice'} | ||
| ], | ||
| footer: { | ||
| message: '<a href="https://openrouteservice.org/">openrouteservice</a> is part of <a href="https://heigit.org/">HeiGIT gGmbH</a> and Universität Heidelberg <a href="https://www.geog.uni-heidelberg.de/gis/index_en.html">GIScience</a> research group. | <a href="https://heigit.org/imprint/">Imprint</a>' | ||
| } | ||
| } | ||
| }) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| :root { | ||
| --vp-c-brand-1: #b5152b; | ||
| --vp-button-brand-bg: #b5152b; | ||
| --vp-c-brand-2: #b5152b; | ||
| /* values below are taken from the old Jekyll installation of the docs */ | ||
| --vp-font-family-base: "Open Sans", "Helvetica Neue", Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji"; | ||
| --vp-font-family-mono: "SFMono-Regular",menlo,consolas,monospace; | ||
| } | ||
|
|
||
| .vp-doc h1, .vp-doc h2, .vp-doc h3, .vp-doc h4, .vp-doc h5, .vp-doc h6 { | ||
| font-weight: 300; | ||
| } | ||
|
|
||
| /* | ||
| //$body-font-family: "Open Sans", "Helvetica Neue", Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji"; | ||
| //$root-font-size: 14px; // Base font-size for rems | ||
| //$font-size-8: 28px; //h1 | ||
| // | ||
| //$body-background-color: #fbfcfd; | ||
| //$code-background-color: #f7f7f7; | ||
| // | ||
| //$body-text-color: #5c5c5c; | ||
| //$link-color: #d60039; | ||
| //$border: 1px solid !default; | ||
| //$border-color: #cfcfcf; | ||
| */ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| // .vitepress/theme/index.js | ||
| import DefaultTheme from 'vitepress/theme-without-fonts' | ||
| import './custom.css' | ||
|
|
||
| export default DefaultTheme |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.