Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Add docs/Guides submodule (mirror of WebKit wiki content) #87

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add docs/Guides submodule (mirror of WebKit wiki content) #87

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitmodules
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[submodule "docs/Guides"]
path = docs/Guides
url = [email protected]:WebKit/WebKit.wiki.git
5 changes: 5 additions & 0 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
docs/Guides/index.md:
cp docs/Guides/Home.md docs/Guides/index.md

clean:
$(RM) docs/Guides/index.md
6 changes: 6 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

```
Expand Down
1 change: 1 addition & 0 deletions docs/Guides
Open in desktop
Submodule Guides added at 34c883