Skip to content

vapor/api-docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

298 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Vapor API Docs

Source for api.vapor.codes — the unified API reference for Vapor and its ecosystem.

It's a Kiln site that renders pre-built DocC archives into the shared Vapor design system, with a module catalog, search, and per-package version switchers.

Running locally

kiln serve   # build + preview at http://127.0.0.1:8080, rebuilding on change
kiln build   # build the static site into ./site

A build reuses the DocC archives already in Content/archives and only generates missing ones. Delete an archive (or the whole folder) to regenerate it on the next build.

Adding or changing a package

Edit Sources/APIDocs/Packages.swift: each APIPackage is one repo, and each PackageVersion declares the modules it ships. See the Kiln DocC docs for the config API.

About

Scripts and assets for Vapor's API documentation site at https://api.vapor.codes

Topics

Resources

License

Code of conduct

Contributing

Security policy

Stars

14 stars

Watchers

15 watching

Forks

Sponsor this project

  •  

Contributors

Languages