Usage and contribution
This documentation is made with mkdocs and mkdocs-material. On this page you will find instructions on how to work effectively with the documentation and how to contribute.
Search and page navigation¶
The most efficient way to find things in the documentation is to use the search function. In many cases, just one keyword will be enough to find the right page. You can access the search function using the search bar at the top or keyboard shortcuts.
Keyboard shortcuts¶
- The search function can be conveniently controlled via the keyboard. The same applies to navigation between pages. There are two modes for the search function:
-
This mode is active when the search bar is focused. It offers several keys to make the search accessible and navigable via the keyboard:
- Down , Up : Select next/previous search result
- Esc , Tab : Close search dialog
- Enter : Open search result
-
This mode is active when search bar is not focused and when there is no other focused element that is receptive to keyboard input. The following keys are bound:
- F , S , / : Open search dialog
- P , , : Next page
- N , . : Previous page
See here for more information on creating your own key combinations.
How to contribute¶
Setup development environment¶
This documentation was created with Materials for MkDocs. The content is written in Markdown, a simple markup language whose basic elements can be learned in 15 minutes. Setting up MkDocs Material is easy! Follow the steps in the first steps tutorial to set up you development environment. We recommend Visual Studio Code as IDE. Here are some useful instructions for the configuration of VS code for configuration validation and auto-complete.
Contribute¶
We are happy for all contributions! To edit or expand the documentation, create a new branch from main in the 3dcitydb/3dcitydb-mkdocs repo on Github and commit your changes there. When your done, submit a pull request so we can review your content. If you find an error or want to discuss content, please file an issue or contribute to the 3DCityDB discussion board. For details on the Markdown or the documentation system, view the references below.