-
-
Notifications
You must be signed in to change notification settings - Fork 2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'develop' into renovate/babel-monorepo
- Loading branch information
Showing
10 changed files
with
174 additions
and
82 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,102 @@ | ||
name: Deploy documentation | ||
|
||
on: | ||
push: | ||
branches: [develop] | ||
workflow_dispatch: {} | ||
|
||
permissions: | ||
contents: read | ||
pages: write | ||
id-token: write | ||
|
||
concurrency: | ||
group: "pages" | ||
cancel-in-progress: false | ||
|
||
jobs: | ||
build: | ||
name: GitHub Pages | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Fetch element-desktop | ||
uses: actions/checkout@v4 | ||
with: | ||
repository: vector-im/element-desktop | ||
path: element-desktop | ||
|
||
- name: Fetch element-web | ||
uses: actions/checkout@v4 | ||
with: | ||
path: element-web | ||
|
||
- name: Fetch matrix-react-sdk | ||
uses: actions/checkout@v4 | ||
with: | ||
repository: matrix-org/matrix-react-sdk | ||
path: matrix-react-sdk | ||
|
||
- name: Fetch matrix-js-sdk | ||
uses: actions/checkout@v4 | ||
with: | ||
repository: matrix-org/matrix-js-sdk | ||
path: matrix-js-sdk | ||
|
||
- name: Setup mdBook | ||
uses: peaceiris/actions-mdbook@v1 | ||
with: | ||
mdbook-version: "0.4.10" | ||
|
||
- name: Install mdbook-combiner | ||
run: cargo install mdbook-combiner | ||
|
||
- name: Prepare docs | ||
run: | | ||
mkdir docs | ||
mv element-desktop/README.md element-desktop/docs/ | ||
mv element-desktop/docs "docs/Element Desktop" | ||
mv element-web/README.md element-web/docs/ | ||
mv element-web/docs "docs/Element Web" | ||
mv matrix-react-sdk/README.md matrix-react-sdk/docs/ | ||
mv matrix-react-sdk/docs "docs/Matrix React SDK" | ||
mv matrix-js-sdk/README.md matrix-js-sdk/docs/ | ||
mv matrix-js-sdk/docs "docs/Matrix JS SDK" | ||
sed -i -e 's/\.\.\/README.md/README.md/' docs/**/SUMMARY.md | ||
mdbook-combiner -m docs | ||
sed -i -E 's/^\t# (.+)$/- [\1]()/gm;t' SUMMARY.md | ||
sed -i -E 's/^- \[(.+)]\(<>\)$/---\n# \1/gm;t' SUMMARY.md | ||
sed -i -E 's/\t- \[Introduction]/- [Introduction]/gm;t' SUMMARY.md | ||
cat <<EOF > docs/SUMMARY.md | ||
# Summary | ||
- [Introduction](<Element Web/README.md>) | ||
EOF | ||
cat SUMMARY.md >> docs/SUMMARY.md | ||
mv element-web/book.toml . | ||
- name: Build docs | ||
run: mdbook build | ||
|
||
- name: Upload artifact | ||
uses: actions/upload-pages-artifact@v2 | ||
with: | ||
path: ./book | ||
|
||
deploy: | ||
environment: | ||
name: github-pages | ||
url: ${{ steps.deployment.outputs.page_url }} | ||
runs-on: ubuntu-latest | ||
needs: build | ||
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -27,3 +27,4 @@ electron/pub | |
# Auto-generated file | ||
/src/modules.ts | ||
/build_config.yaml | ||
/book |
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 @@ | ||
# Documentation for possible options in this file is at | ||
# https://rust-lang.github.io/mdBook/format/config.html | ||
[book] | ||
title = "Element Web & Desktop" | ||
authors = ["New Vector Ltd.", "The Matrix.org Foundation C.I.C."] | ||
language = "en" | ||
multilingual = false | ||
|
||
# The directory that documentation files are stored in | ||
src = "docs" | ||
|
||
[build] | ||
# Prevent markdown pages from being automatically generated when they're | ||
# linked to in SUMMARY.md | ||
create-missing = false | ||
|
||
[output.html] | ||
# Remove the numbers that appear before each item in the sidebar, as they can | ||
# get quite messy as we nest deeper | ||
no-section-label = true | ||
|
||
# The source code URL of the repository | ||
git-repository-url = "https://github.com/vector-im/element-web" | ||
|
||
# The path that the docs are hosted on | ||
site-url = "/element-web/" |
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,38 @@ | ||
# Summary | ||
|
||
- [Introduction](../README.md) | ||
|
||
# Usage | ||
|
||
- [Betas](betas.md) | ||
- [Labs](labs.md) | ||
|
||
# Setup | ||
|
||
- [Config](config.md) | ||
- [Custom home page](custom-home.md) | ||
- [Kubernetes](kubernetes.md) | ||
- [Jitsi](jitsi.md) | ||
- [Encryption](e2ee.md) | ||
|
||
# Build | ||
|
||
- [Customisations](customisations.md) | ||
- [Modules](modules.md) | ||
- [Native Node modules](native-node-modules.md) | ||
|
||
# Contribution | ||
|
||
- [Choosing an issue](choosing-an-issue.md) | ||
- [Translation](translating.md) | ||
- [Netlify builds](pr-previews.md) | ||
- [Code review](review.md) | ||
|
||
# Development | ||
|
||
- [App load order](app-load.md) | ||
- [Translation](translating-dev.md) | ||
- [Theming](theming.md) | ||
- [Memory profiling](memory-profiles-and-leaks.md) | ||
- [Jitsi](jitsi-dev.md) | ||
- [Feature flags](feature-flags.md) |
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 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 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