shawnbot/swagger-template

What about stylesheets?

Open

#1 opened on Feb 3, 2015

View on GitHub
 (0 comments) (0 reactions) (0 assignees) (0 forks)github user discovery
help wanted

Repository metrics

Stars
 (2 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

This was originally part of shawnbot/swagger-static#1, but I'm moving it here for safe keeping.

Here are some options for distributing stylesheets:

  1. Just bundle a stylesheet with swagger-template and let people copy it as needed.

  2. Make a CDN-hosted default stylesheet and reference that in the swagger-template.

  3. Ignore styling altogether and let users specify stylesheets in a custom template, as in:

    {% extend "swagger.html" %}
{% block css %}
<link rel="stylesheet" href="path/to/custom.css">
{% endblock %}

Contributor guide

Research direction
Evaluate the three options for distributing stylesheets: bundling, CDN hosting, or ignoring and letting users specify in custom templates. Consider ease of use, maintenance, and flexibility.
Tech stack
htmlcss
Domain
frontend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90