https://github.com/webkit/documentation
Documentation for the WebKit project, hosted at https://docs.webkit.org.
https://github.com/webkit/documentation
documentation webkit
Last synced: 10 months ago
JSON representation
Documentation for the WebKit project, hosted at https://docs.webkit.org.
- Host: GitHub
- URL: https://github.com/webkit/documentation
- Owner: WebKit
- Created: 2022-09-16T19:56:43.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-03-31T16:22:01.000Z (10 months ago)
- Last Synced: 2025-03-31T17:31:52.128Z (10 months ago)
- Topics: documentation, webkit
- Homepage: https://docs.webkit.org
- Size: 38.7 MB
- Stars: 69
- Watchers: 61
- Forks: 30
- Open Issues: 24
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# WebKit Documentation
This repository contains the documentation for the WebKit Project.
## Build Documentation
### Install Dependencies
```python
pip3 install mkdocs-material
```
### Preview Documentation Locally
This will bring up a local web server, so you can see the documentation locally. Any updates you make will be automatically visible.
```
mkdocs serve
```
### Release Build
Build documentation for static site.
```
mkdocs build
python3 -m http.server --directory site/ # (Optional) View generated documentation
```
### Overview
The documentation uses the [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) theme. This documentation has been collected from a variety of sources including [Trac](https://trac.webkit.org), [GitHub Wiki](https://github.com/WebKit/WebKit/wiki), and WebKit source code markdown files.