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

docs(topojson-export): add topojson response documentation #1935

Merged
merged 10 commits into from
Jan 8, 2025
2 changes: 1 addition & 1 deletion CONTRIBUTE.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

<!-- /TOC -->

**Firstly, thanks for using the ORS and contributing to making it better for everyone.**
**Firstly, thanks for using openrouteservice and contributing to making it better for everyone.**

Openrouteservice has been around for over ten years, and as such it has seen many changes and adoption of new
methodologies and techniques, as well as the coming and going of multiple developers.
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,4 +115,4 @@ For questions please use our [community forum](https://ask.openrouteservice.org)

## Translations

If you notice anything wrong with translations, or you want to add a new language to the ORS instructions, we have some instructions in our [backend documentation](https://GIScience.github.io/openrouteservice/contributing/contributing-translations) about how you can submit an update. You can also look over at our [maps client GitHub](https://github.com/GIScience/ors-map-client/#add-language) if you want to contribute the language to there as well (adding or editing the language in the openrouteservice GitHub repo only affects the instructions - any new language also needs adding to the client).
If you notice anything wrong with translations, or you want to add a new language to the openrouteservice instructions, we have some instructions in our [backend documentation](https://GIScience.github.io/openrouteservice/contributing/contributing-translations) about how you can submit an update. You can also look over at our [maps client GitHub](https://github.com/GIScience/ors-map-client/#add-language) if you want to contribute the language to there as well (adding or editing the language in the openrouteservice GitHub repo only affects the instructions - any new language also needs adding to the client).
438 changes: 250 additions & 188 deletions docs/.vitepress/config.js

Large diffs are not rendered by default.

9 changes: 8 additions & 1 deletion docs/.vitepress/theme/index.ts
Original file line number Diff line number Diff line change
@@ -1,11 +1,18 @@
import DefaultTheme from 'vitepress/theme-without-fonts'
import './custom.css'
import { Theme } from 'vitepress';
import { Theme, useData, useRoute } from 'vitepress';
import VersionSwitcher from "../components/VersionSwitcher.vue";
import codeblocksFold from 'vitepress-plugin-codeblocks-fold'; // import method
import 'vitepress-plugin-codeblocks-fold/style/index.css'; // import style
koebi marked this conversation as resolved.
Show resolved Hide resolved

export default {
extends: DefaultTheme,
enhanceApp({ app }) {
app.component('VersionSwitcher', VersionSwitcher)
},
setup() {
const { frontmatter } = useData();
const route = useRoute();
codeblocksFold({ route, frontmatter }, false, 200);
}
} satisfies Theme;
4 changes: 2 additions & 2 deletions docs/api-reference/endpoints/elevation/index.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# Elevation Service

:::warning NOTE
This endpoint is not part of the openrouteservice, but of our public API. It is not available when running an own instance of openrouteservice.
This endpoint is not part of openrouteservice, but of our public API. It is not available when running an own instance of openrouteservice.
:::

The elevation service is a Flask application which extracts elevation from various elevation datasets for Point or LineString 2D geometries and returns 3D geometries in various formats.
Just like the openrouteservice, the elevation service is also accessible via our public API.
Just like openrouteservice, the elevation service is also accessible via our public API.

Details on how to use it can be found in our [API Playground](https://openrouteservice.org/dev/#/api-docs/elevation).

Expand Down
Loading
Loading