-
-
Notifications
You must be signed in to change notification settings - Fork 356
docs: add more meat to the development section #1801
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
Merged
CommanderStorm
merged 21 commits into
maplibre:main
from
CommanderStorm:better-dev-docs
Apr 25, 2025
Merged
Changes from all commits
Commits
Show all changes
21 commits
Select commit
Hold shift + click to select a range
9cee16a
improve the development section
CommanderStorm 94b9d01
Merge branch 'main' into better-dev-docs
CommanderStorm 47da97e
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] 9df1d58
Fix typo
CommanderStorm e3029c1
fix formatting
CommanderStorm 98215ff
Merge branch 'main' into better-dev-docs
nyurik e2dae68
Update docs/src/martin-as-a-library.md
nyurik a313db3
Update docs/src/development.md
CommanderStorm eff8878
Update docs/README.md
CommanderStorm 7a77968
Update docs/README.md
CommanderStorm c151578
Update docs/src/development.md
CommanderStorm f4751f6
Update docs/src/martin-as-a-library.md
CommanderStorm 822ada5
Update docs/src/development.md
CommanderStorm 1412092
Update docs/src/development.md
CommanderStorm f9856f8
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] 58cf4b6
Update docs/src/development.md
CommanderStorm 940554f
Update docs/README.md
CommanderStorm 2d5cc88
Merge branch 'main' into better-dev-docs
CommanderStorm 8bd110f
Update docs/src/development.md
CommanderStorm a7f1ae9
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] c18689a
Merge branch 'main' into better-dev-docs
CommanderStorm File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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,31 @@ | ||
| # Martins documentation | ||
|
|
||
| The documentation of `maplibre/martin` is available at <https://maplibre.org/martin>. | ||
|
|
||
| To build/develop this documentation locally, you can install `mdbook` and `mdbook-linkcheck`. | ||
|
|
||
| ```bash | ||
| cargo install mdbook | ||
| ``` | ||
|
|
||
| ## Development | ||
|
|
||
| You can simply edit the markdown files in the `src` directory and run the following command (from the project root directory) to preview the changes: | ||
|
|
||
| ```bash | ||
| mdbook watch --open docs | ||
| ``` | ||
|
|
||
| Next to showing you how the docs will look, this also runs a link checker to ensure that all links are valid. | ||
|
|
||
| > [!TIP] | ||
| > Make sure that all pages are linked from [`src/SUMMARY.md`](src/SUMMARY.md). | ||
| > **Only** pages linked will be rendered. | ||
| > See the [mdbook documentation](https://rust-lang.github.io/mdBook/) for more information. | ||
|
|
||
| > [!NOTE] | ||
| > Files may only be added, not renamed. | ||
| > If you want to rename a file, make sure to [add a redirect to the new file in `output.html.redirect`](https://rust-lang.github.io/mdBook/format/configuration/renderers.html#outputhtmlredirect). | ||
| > Renaming files would otherwise break existing, external links for example on stackoverflow or github-discussions. | ||
| > | ||
| > Removing is bad for the same reasons and will be handled on a case-by-case basis. |
This file contains hidden or 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 hidden or 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
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.