From c9d085a4736aaf36a62753084bd3f4253fb47341 Mon Sep 17 00:00:00 2001 From: Oliver Wipfli Date: Mon, 31 Oct 2022 15:54:14 +0100 Subject: [PATCH] Add rust book for documenation (#533) --- .github/workflows/build-deploy-docs.yml | 43 +++ docs/.gitignore | 2 + docs/README.md | 11 + docs/book.toml | 9 + docs/diff.css | 372 ++++++++++++++++++++++++ docs/src/SUMMARY.md | 3 + docs/src/introduction.md | 3 + 7 files changed, 443 insertions(+) create mode 100644 .github/workflows/build-deploy-docs.yml create mode 100644 docs/.gitignore create mode 100644 docs/README.md create mode 100644 docs/book.toml create mode 100644 docs/diff.css create mode 100644 docs/src/SUMMARY.md create mode 100644 docs/src/introduction.md diff --git a/.github/workflows/build-deploy-docs.yml b/.github/workflows/build-deploy-docs.yml new file mode 100644 index 000000000..c01a9d7af --- /dev/null +++ b/.github/workflows/build-deploy-docs.yml @@ -0,0 +1,43 @@ +name: Build documentation + +on: + workflow_dispatch: + + +jobs: + build-docs: + name: Build + runs-on: ubuntu-20.04 + steps: + - uses: actions/checkout@v2 + - uses: extractions/setup-just@v1 + - name: Setup mdBook + uses: peaceiris/actions-mdbook@v1 + - name: Install Dependencies + shell: bash + run: sudo apt-get install -y libwayland-dev libxkbcommon-dev # Required for winit + - name: Build + working-directory: docs + shell: bash + run: mdbook build + - uses: actions/upload-artifact@v2 + with: + name: book + path: docs/book/ + deploy-docs: + needs: build-docs + name: Deploy + runs-on: ubuntu-20.04 + steps: + - uses: actions/checkout@v2 + - name: Download book + uses: actions/download-artifact@v2 + with: + name: book + path: artifacts/book + - name: Deploy + uses: JamesIves/github-pages-deploy-action@v4.3.3 + with: + branch: gh-pages + folder: artifacts + target-folder: docs diff --git a/docs/.gitignore b/docs/.gitignore new file mode 100644 index 000000000..712ac0122 --- /dev/null +++ b/docs/.gitignore @@ -0,0 +1,2 @@ +book +*.bkp \ No newline at end of file diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 000000000..b434eb6c8 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,11 @@ +# MapLibre GL Native Docs + +## Build Locally + +Get the `mdbook` utility, see https://rust-lang.github.io/mdBook/guide/installation.html + +Run + +``` +mdbook serve . +``` diff --git a/docs/book.toml b/docs/book.toml new file mode 100644 index 000000000..3ebfc40ce --- /dev/null +++ b/docs/book.toml @@ -0,0 +1,9 @@ +[book] +authors = ["MapLibre Contributors"] +language = "en" +multilingual = false +src = "src" +title = "MapLibre GL Native Documentation" + +[output.html] +additional-css = ["diff.css"] diff --git a/docs/diff.css b/docs/diff.css new file mode 100644 index 000000000..623e2edb6 --- /dev/null +++ b/docs/diff.css @@ -0,0 +1,372 @@ + +.d2h-d-none { + display: none +} + +.d2h-wrapper { + text-align: left +} + +.d2h-file-header { + background-color: #f7f7f7; + border-bottom: 1px solid #d8d8d8; + font-family: Source Sans Pro, Helvetica Neue, Helvetica, Arial, sans-serif; + height: 35px; + padding: 5px 10px +} + +.d2h-file-header, .d2h-file-stats { + display: -webkit-box; + display: -ms-flexbox; + display: flex +} + +.d2h-file-stats { + font-size: 14px; + margin-left: auto +} + +.d2h-lines-added { + border: 1px solid #b4e2b4; + border-radius: 5px 0 0 5px; + color: #399839; + padding: 2px; + text-align: right; + vertical-align: middle +} + +.d2h-lines-deleted { + border: 1px solid #e9aeae; + border-radius: 0 5px 5px 0; + color: #c33; + margin-left: 1px; + padding: 2px; + text-align: left; + vertical-align: middle +} + +.d2h-file-name-wrapper { + -webkit-box-align: center; + -ms-flex-align: center; + align-items: center; + display: -webkit-box; + display: -ms-flexbox; + display: flex; + font-size: 15px; + width: 100% +} + +.d2h-file-name { + overflow-x: hidden; + text-overflow: ellipsis; + white-space: nowrap +} + +.d2h-file-wrapper { + border: 1px solid #ddd; + border-radius: 3px; + margin-bottom: 1em +} + +.d2h-file-collapse { + -webkit-box-pack: end; + -ms-flex-pack: end; + -webkit-box-align: center; + -ms-flex-align: center; + align-items: center; + border: 1px solid #ddd; + border-radius: 3px; + cursor: pointer; + display: none; + font-size: 12px; + justify-content: flex-end; + padding: 4px 8px +} + +.d2h-file-collapse.d2h-selected { + background-color: #c8e1ff +} + +.d2h-file-collapse-input { + margin: 0 4px 0 0 +} + +.d2h-diff-table { + border-collapse: collapse; + font-family: Menlo, Consolas, monospace; + font-size: 13px; + width: 100% +} + +.d2h-files-diff { + width: 100% +} + +.d2h-file-diff { + overflow-y: hidden +} + +.d2h-file-side-diff { + display: inline-block; + margin-bottom: -8px; + margin-right: -4px; + overflow-x: scroll; + overflow-y: hidden; + width: 50% +} + +/*.d2h-code-line { + padding: 0 8em +}*/ + +.d2h-code-line, .d2h-code-side-line { + display: inline-block; + -webkit-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + user-select: none; + white-space: nowrap; + width: 100% +} + +.d2h-code-side-line { + padding: 0 4.5em +} + +.d2h-code-line-ctn { + word-wrap: normal; + background: none; + display: inline-block; + padding: 0; + -webkit-user-select: text; + -moz-user-select: text; + -ms-user-select: text; + user-select: text; + vertical-align: middle; + white-space: pre; + width: 100% +} + +.d2h-code-line del, .d2h-code-side-line del { + background-color: #ffb6ba +} + +.d2h-code-line del, .d2h-code-line ins, .d2h-code-side-line del, .d2h-code-side-line ins { + border-radius: .2em; + display: inline-block; + margin-top: -1px; + text-decoration: none; + vertical-align: middle +} + +.d2h-code-line ins, .d2h-code-side-line ins { + background-color: #97f295; + text-align: left +} + +.d2h-code-line-prefix { + word-wrap: normal; + background: none; + display: inline; + padding: 0; + white-space: pre +} + +.line-num1 { + float: left +} + +.line-num1, .line-num2 { + -webkit-box-sizing: border-box; + box-sizing: border-box; + overflow: hidden; + padding: 0 .5em; + text-overflow: ellipsis; + width: 3.5em +} + +.line-num2 { + float: right +} + +.d2h-code-linenumber { + display: none !important; +} + +/*.d2h-code-linenumber { + background-color: #fff; + border: solid #eee; + border-width: 0 1px; + -webkit-box-sizing: border-box; + box-sizing: border-box; + color: rgba(0, 0, 0, .3); + cursor: pointer; + display: inline-block; + position: absolute; + text-align: right; + width: 7.5em +}*/ + +.d2h-code-linenumber:after { + content: "\200b" +} + +.d2h-code-side-linenumber { + background-color: #fff; + border: solid #eee; + border-width: 0 1px; + -webkit-box-sizing: border-box; + box-sizing: border-box; + color: rgba(0, 0, 0, .3); + cursor: pointer; + display: inline-block; + overflow: hidden; + padding: 0 .5em; + position: absolute; + text-align: right; + text-overflow: ellipsis; + width: 4em +} + +.d2h-code-side-linenumber:after { + content: "\200b" +} + +.d2h-code-side-emptyplaceholder, .d2h-emptyplaceholder { + background-color: #f1f1f1; + border-color: #e1e1e1 +} + +.d2h-code-line-prefix, .d2h-code-linenumber, .d2h-code-side-linenumber, .d2h-emptyplaceholder { + -webkit-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + user-select: none +} + +.d2h-code-linenumber, .d2h-code-side-linenumber { + direction: rtl +} + +.d2h-del { + background-color: #fee8e9; + border-color: #e9aeae +} + +.d2h-ins { + background-color: #dfd; + border-color: #b4e2b4 +} + +.d2h-info { + background-color: #f8fafd; + border-color: #d5e4f2; + color: rgba(0, 0, 0, .3) +} + +.d2h-file-diff .d2h-del.d2h-change { + background-color: #fdf2d0 +} + +.d2h-file-diff .d2h-ins.d2h-change { + background-color: #ded +} + +.d2h-file-list-wrapper { + margin-bottom: 10px +} + +.d2h-file-list-wrapper a { + color: #3572b0; + text-decoration: none +} + +.d2h-file-list-wrapper a:visited { + color: #3572b0 +} + +.d2h-file-list-header { + text-align: left +} + +.d2h-file-list-title { + font-weight: 700 +} + +.d2h-file-list-line { + display: -webkit-box; + display: -ms-flexbox; + display: flex; + text-align: left +} + +.d2h-file-list { + display: block; + list-style: none; + margin: 0; + padding: 0 +} + +.d2h-file-list > li { + border-bottom: 1px solid #ddd; + margin: 0; + padding: 5px 10px +} + +.d2h-file-list > li:last-child { + border-bottom: none +} + +.d2h-file-switch { + cursor: pointer; + display: none; + font-size: 10px +} + +.d2h-icon { + fill: currentColor; + margin-right: 10px; + vertical-align: middle +} + +.d2h-deleted { + color: #c33 +} + +.d2h-added { + color: #399839 +} + +.d2h-changed { + color: #d0b44c +} + +.d2h-moved { + color: #3572b0 +} + +.d2h-tag { + background-color: #fff; + display: -webkit-box; + display: -ms-flexbox; + display: flex; + font-size: 10px; + margin-left: 5px; + padding: 0 2px +} + +.d2h-deleted-tag { + border: 1px solid #c33 +} + +.d2h-added-tag { + border: 1px solid #399839 +} + +.d2h-changed-tag { + border: 1px solid #d0b44c +} + +.d2h-moved-tag { + border: 1px solid #3572b0 +} \ No newline at end of file diff --git a/docs/src/SUMMARY.md b/docs/src/SUMMARY.md new file mode 100644 index 000000000..93b80f22f --- /dev/null +++ b/docs/src/SUMMARY.md @@ -0,0 +1,3 @@ +# maplibre-gl-native documentation + +[Introduction](./introduction.md) diff --git a/docs/src/introduction.md b/docs/src/introduction.md new file mode 100644 index 000000000..524a57e77 --- /dev/null +++ b/docs/src/introduction.md @@ -0,0 +1,3 @@ +# Introduction + +Hi, Prateek!