Nothing Special   »   [go: up one dir, main page]

Skip to content

WebKit/Documentation

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

WebKit Documentation

This repository contains the documentation for the WebKit Project.

Build Documentation

Install Dependencies

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 theme. This documentation has been collected from a variety of sources including Trac, GitHub Wiki, and WebKit source code markdown files.