From a189794f080b502d8a8583c4fca09551d786af61 Mon Sep 17 00:00:00 2001 From: sideshowbarker Date: Wed, 10 Apr 2024 22:00:50 +0900 Subject: [PATCH] Add docs/Guides submodule (mirror of WebKit wiki content) --- .gitmodules | 3 +++ Makefile | 5 +++++ README.md | 6 ++++++ docs/Guides | 1 + 4 files changed, 15 insertions(+) create mode 100644 .gitmodules create mode 100644 Makefile create mode 160000 docs/Guides diff --git a/.gitmodules b/.gitmodules new file mode 100644 index 00000000..a6287d97 --- /dev/null +++ b/.gitmodules @@ -0,0 +1,3 @@ +[submodule "docs/Guides"] + path = docs/Guides + url = git@github.com:WebKit/WebKit.wiki.git diff --git a/Makefile b/Makefile new file mode 100644 index 00000000..e351f69d --- /dev/null +++ b/Makefile @@ -0,0 +1,5 @@ +docs/Guides/index.md: + cp docs/Guides/Home.md docs/Guides/index.md + +clean: + $(RM) docs/Guides/index.md diff --git a/README.md b/README.md index 56f05ae7..d41c1d57 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,12 @@ pip3 install mkdocs-material ### Preview Documentation Locally +This will pull the **Guides** submodule from the contents of the WebKit wiki, and copy the `Guides/Home.md` file to `Guides/index.md`: + +``` +git pull --recurse-submodules && make +``` + This will bring up a local web server, so you can see the documentation locally. Any updates you make will be automatically visible. ``` diff --git a/docs/Guides b/docs/Guides new file mode 160000 index 00000000..34c88351 --- /dev/null +++ b/docs/Guides @@ -0,0 +1 @@ +Subproject commit 34c88351ba80889598725cc7ea1318f3f889d0cd