Light

vapor / api-docs Goto Github PK

View Code? Open in Web Editor NEW

9.0 20.0 5.0 30.16 MB

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

Home Page: https://api.vapor.codes

License: MIT License

Swift 80.95% HTML 19.05%

api documentation documentation-site reference swift vapor

api-docs's Introduction

Vapor is an HTTP web framework for Swift. It provides a beautifully expressive and easy-to-use foundation for your next website, API, or cloud project.

Take a look at some of the awesome stuff created with Vapor.

💧 Community

Join the welcoming community of fellow Vapor developers on Discord.

🚀 Contributing

To contribute a feature or idea to Vapor, create an issue explaining your idea or bring it up on Discord.

If you find a bug, please create an issue.

If you find a security vulnerability, please contact [email protected] as soon as possible.

💛 Sponsors

Support Vapor's development by becoming a sponsor.

💚 Backers

Support Vapor's development by becoming a backer.

api-docs's People

Contributors

Stargazers

Watchers

Forkers

antonasg ckd arkhan19 grundoon isabella232

api-docs's Issues

API/Fluent: White text on white background

Describe the bug

White text on white background is not readable.

To Reproduce

Go to https://api.vapor.codes/fluent/documentation/fluent/

Expected behavior

Expect some contrast between the text and the background.

Environment

Vapor Framework version: current https://api.vapor.codes/ website
Vapor Toolbox version: N/A
OS version: N/A

Additional context

Unknown if this is an issue on other api pages. A sampling of other API pages looked ok.

[API Docs] roadmap?

The api.vapor.codes currently has only one package PostgresNIO. This is substantially less than the API Docs packages that were available for Vapor 3.

Is the go forward intent to have API Docs (1) just be PostgresNIO, (2) to be phased out or (3) to have the various packages added again?

Add CSP Header

We currently add the Content-Security-Policy-Report-Only header to pages. This has been running for a while now and we should check what needs changing in the CSP and actually deploy it

Support API Documentation Versioning

With Vapor 2.0 making significant changes to the API, it would be a good idea to support different versions of the API documentation.

404 page is not working correctly

Attempting to access old pages which results in a 403 - this should be a 404 to help link checkers and a better experience for users

Recommend Projects

React

A declarative, efficient, and flexible JavaScript library for building user interfaces.
Vue.js

🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript

TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
TensorFlow

An Open Source Machine Learning Framework for Everyone
Django

The Web framework for perfectionists with deadlines.
Laravel

A PHP framework for web artisans
D3

Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

javascript

JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
web

Some thing interesting about web. New door for the world.
server

A server is a program made to process requests and deliver data to clients.
Machine learning

Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Visualization

Some thing interesting about visualization, use data art
Game

Some thing interesting about game, make everyone happy.

Recommend Org

Facebook

We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft

Open source projects and samples from Microsoft.
Google

Google ❤️ Open Source for everyone.
Alibaba

Alibaba Open Source for everyone
D3

Data-Driven Documents codes.
Tencent

China tencent open source team.