Light

Styling about debugger-protocol-viewer HOT 9 CLOSED

chromedevtools commented on August 11, 2024

Styling

from debugger-protocol-viewer.

Comments (9)

kdzwinel commented on August 11, 2024

JSDoc comes to mind, but it's not exactly beautiful - http://jsdoc.sourceforge.net/example/ .
I can create something simple based on http://getskeleton.com/ (same thing I used for EDL).

from debugger-protocol-viewer.

paulirish commented on August 11, 2024

https://stripe.com/docs/api is pretty attractive.

from debugger-protocol-viewer.

auchenberg commented on August 11, 2024

Github: https://developer.github.com/v3/gists/

Swagger: http://swagger.io/

from debugger-protocol-viewer.

ericguzman commented on August 11, 2024

+1 for Stripe's style.

The more I play with Swagger, the sweeter I think it is as a tool, but you have to start digging around to discover this. Stripe's API doc style + response samples laid out elegantly in the same view make it a more approachable style, IMO.

from debugger-protocol-viewer.

paulirish commented on August 11, 2024

Yup.

http://readme.io/ came out recently to make the stripe style easy for everyone, but AFAICT, we can't just toss it a JSON and have it stay up to date. (@gkoberger can you confirm? - our docs is basically this file)

from debugger-protocol-viewer.

gkoberger commented on August 11, 2024

@paulirish yes and no!

We currently support a few specs (Swagger and APIDoc) where we can auto-generate docs from, and are super interested in adding more. Is the definition in any sort of existing format? Either way, we can probably write some sort of connector for it.

We'd love to help out! (And ReadMe would be free, too, since all this is open source :) )

from debugger-protocol-viewer.

paulirish commented on August 11, 2024

I don't think it currently matches a API spec. Here it is: https://chromium.googlesource.com/chromium/blink/+/master/Source/devtools/protocol.json We currently display it like this https://chromedevtools.github.io/debugger-protocol-viewer/ but we're ready to explore other options. Would an adapter for readme.io be much work?

from debugger-protocol-viewer.

kdzwinel commented on August 11, 2024

@paulirish Since polymer is in place, should we start using material design elements?

from debugger-protocol-viewer.

paulirish commented on August 11, 2024

Sure yah!

from debugger-protocol-viewer.

Related Issues (20)

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.