forked from DizzyEggg/pokeemerald
-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Convert docs/ folder to mdBook (#4684)
* Convert docs/ folder to mdBook * INSTALL.md Markdown fixes (also affects GitHub web) * Don't try to rewrite bare links in HTML attributes * lowercase anchors in fix_links.py
- Loading branch information
Showing
11 changed files
with
178 additions
and
18 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,37 @@ | ||
| name: Docs | ||
| on: | ||
| push: | ||
| branches: | ||
| - master | ||
|
|
||
| jobs: | ||
| deploy: | ||
| runs-on: ubuntu-latest | ||
| permissions: | ||
| contents: write | ||
| pages: write | ||
| id-token: write | ||
| steps: | ||
| - uses: actions/checkout@v4 | ||
| with: | ||
| fetch-depth: 0 | ||
| - name: Install latest mdbook | ||
| run: | | ||
| tag=$(curl 'https://api.github.com/repos/rust-lang/mdbook/releases/latest' | jq -r '.tag_name') | ||
| url="https://github.com/rust-lang/mdbook/releases/download/${tag}/mdbook-${tag}-x86_64-unknown-linux-gnu.tar.gz" | ||
| mkdir mdbook | ||
| curl -sSL $url | tar -xz --directory=./mdbook | ||
| echo `pwd`/mdbook >> $GITHUB_PATH | ||
| - name: Build Book | ||
| run: | | ||
| cd docs | ||
| mdbook build | ||
| - name: Setup Pages | ||
| uses: actions/configure-pages@v4 | ||
| - name: Upload artifact | ||
| uses: actions/upload-pages-artifact@v3 | ||
| with: | ||
| path: 'docs/book' | ||
| - name: Deploy to GitHub Pages | ||
| id: deployment | ||
| uses: actions/deploy-pages@v4 |
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
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 @@ | ||
| 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 @@ | ||
| ../CHANGELOG.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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| ../INSTALL.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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| ../README.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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,52 @@ | ||
| # Summary | ||
|
|
||
| - [README](./README.md) | ||
| - [Installation](./INSTALL.md) | ||
| - [Setting up WSL1 (Legacy Portion)](./legacy_WSL1_INSTALL.md) | ||
| - [Changelog](./CHANGELOG.md) | ||
| - [1.8.x]() | ||
| - [Version 1.8.4](changelogs/1.8.x/1.8.4.md) | ||
| - [Version 1.8.3](changelogs/1.8.x/1.8.3.md) | ||
| - [Version 1.8.2](changelogs/1.8.x/1.8.2.md) | ||
| - [Version 1.8.1](changelogs/1.8.x/1.8.1.md) | ||
| - [Version 1.8.0](changelogs/1.8.x/1.8.0.md) | ||
|
|
||
| - [1.7.x]() | ||
| - [Version 1.7.4](changelogs/1.7.x/1.7.4.md) | ||
| - [Version 1.7.3](changelogs/1.7.x/1.7.3.md) | ||
| - [Version 1.7.2](changelogs/1.7.x/1.7.2.md) | ||
| - [Version 1.7.1](changelogs/1.7.x/1.7.1.md) | ||
| - [Version 1.7.0](changelogs/1.7.x/1.7.0.md) | ||
|
|
||
| - [1.6.x]() | ||
| - [Version 1.6.2](changelogs/1.6.x/1.6.2.md) | ||
| - [Version 1.6.1](changelogs/1.6.x/1.6.1.md) | ||
| - [Version 1.6.0](changelogs/1.6.x/1.6.0.md) | ||
|
|
||
| - [1.5.x]() | ||
| - [Version 1.5.3](changelogs/1.5.x/1.5.3.md) | ||
| - [Version 1.5.2](changelogs/1.5.x/1.5.2.md) | ||
| - [Version 1.5.1](changelogs/1.5.x/1.5.1.md) | ||
| - [Version 1.5.0](changelogs/1.5.x/1.5.0.md) | ||
|
|
||
| - [1.4.x]() | ||
| - [Version 1.4.3](changelogs/1.4.x/1.4.3.md) | ||
| - [Version 1.4.2](changelogs/1.4.x/1.4.2.md) | ||
| - [Version 1.4.1](changelogs/1.4.x/1.4.1.md) | ||
| - [Version 1.4.0](changelogs/1.4.x/1.4.0.md) | ||
|
|
||
| - [1.3.x]() | ||
| - [Version 1.3.0](changelogs/1.3.x/1.3.0.md) | ||
|
|
||
| - [1.2.x]() | ||
| - [Version 1.2.0](changelogs/1.2.x/1.2.0.md) | ||
|
|
||
| - [1.1.x]() | ||
| - [Version 1.1.1](changelogs/1.1.x/1.1.1.md) | ||
| - [Version 1.1.0](changelogs/1.1.x/1.1.0.md) | ||
|
|
||
| - [1.0.x]() | ||
| - [Version 1.0.0](changelogs/1.0.x/1.0.0.md) | ||
|
|
||
| - [Pre-1.0.x]() | ||
| - [Version 0.9.0](changelogs/0.9.x/0.9.0.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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| [book] | ||
| language = "en" | ||
| multilingual = false | ||
| src = "." | ||
| title = "pokeemerald-expansion" | ||
|
|
||
| [output.html] | ||
| git-repository-url = "https://github.com/rh-hideout/pokeemerald-expansion" | ||
| edit-url-template = "https://github.com/rh-hideout/pokeemerald-expansion/edit/master/docs/{path}" | ||
| site-url = "/pokeemerald-expansion/" | ||
|
|
||
| [preprocessor.fix_links] | ||
| command = "python3 fix_links.py" |
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,51 @@ | ||
| # workarounds to avoid changing current directory structure | ||
| # autolink logic based on https://github.com/zopieux/py-gfm/blob/fd7b33ed138d240d24dfb659acff7d4ce3f43745/gfm/autolink.py | ||
|
|
||
| import json | ||
| import sys | ||
| import re | ||
|
|
||
| URL_RE = re.compile( | ||
| r"(```(?s:.)+?```|`.+?`|<.+?>)|" | ||
| r"\b((?:(?i:ftp|https?)://|(?i:www)\d{0,3}[.])(?:[^\s()<>]+|" | ||
| r"\(([^\s()<>]+|(\([^\s()<>]+\)))*\))+(?:\(([^\s()<>]+|(\([^\s()" | ||
| r"<>]+\)))*\)|[^\s`!()\[\]{};:" + r"'" + r'".,<>?«»“”‘’*]))' | ||
| ) | ||
| PROTOCOL_RE = re.compile(r"^(?i:ftp|https?)://") | ||
|
|
||
| ANCHOR_RE = re.compile(r"(\]\((?:[^)#]+\.md)?#)([^)]+\))") | ||
|
|
||
| def handle_url(m): | ||
| code = m.group(1) | ||
| if code: | ||
| return code | ||
| href = m.group(2) | ||
| if not PROTOCOL_RE.match(href): | ||
| href = "http://%s" % href | ||
| return f'<{href}>' | ||
|
|
||
| def handle_anchor(m): | ||
| page = m.group(1) | ||
| anchor = m.group(2) | ||
| return page + anchor.lower() | ||
|
|
||
| def proc_items(items): | ||
| for item in items: | ||
| if 'Chapter' in item: | ||
| s = item['Chapter']['content'] | ||
| s = s.replace('](README.md)', '](./)') | ||
| s = s.replace('](/INSTALL.md', '](INSTALL.md') | ||
| s = s.replace('](docs/', '](') | ||
| item['Chapter']['content'] = URL_RE.sub(handle_url, s) | ||
| item['Chapter']['content'] = ANCHOR_RE.sub(handle_anchor, s) | ||
| proc_items(item['Chapter']['sub_items']) | ||
|
|
||
| if __name__ == '__main__': | ||
| if len(sys.argv) > 1: | ||
| if sys.argv[1] == "supports": | ||
| sys.exit(0) | ||
|
|
||
| context, book = json.load(sys.stdin) | ||
| proc_items(book['sections']) | ||
|
|
||
| print(json.dumps(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