umputun/remark42

Implement and document styles customization

Open

#5 opened on May 12, 2018

View on GitHub
 (17 comments) (19 reactions) (0 assignees)Go (5,500 stars) (432 forks)user submission
enhancementfrontendhelp wanted

Description

We should have a way to define external CSS for basic customizations - things like link colors, font sizes, and other styles.

On compose level this will be as simple as some volume mapping, like - ./etc/styles.css:/srv/web/styles.css

Also, need instructions in the readme on how to do it and what we allow to customize (with an example)

Contributor guide

Tech stack
cssdockerhtml
Domain
frontenddocumentation
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Docker basicsCSS knowledge
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
The issue proposes adding external CSS customization via Docker volume mapping. Research should focus on how Docker volumes work, and which CSS selectors or properties should be overridable. The existing CSS files in the repository should be examined to determine a minimal set of customizable styles. Additionally, the README needs documentation with an example volume mount and a list of customizable elements, such as link colors and font sizes. The maintainer has not yet provided constraints, so any proposed solution should be self contained and easy to test.
Implement and document styles customization · umputun/remark42#5 | Good First Issue