Template contains mkdoclingo.css.

Aperta Adatta ai principianti
#56 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
1/5
Tempo stimato
Meno di un'ora
Idoneità per principianti
68/100
Tipo di issue
Bug
Chiarezza
Specificata chiaramente
Stato di attività
Tranquilla
Stack tecnologico
css
Ambito
documentation

Direzione di ricerca

Inizia ispezionando docs/_custom/css/mkdoclingo.css e confrontalo con lo stile fornito da mkdoclingo. Rimuovi il file CSS del template, quindi verifica che i progetti generati dal template non sovrascrivano più le etichette dei predicati o i colori di mkdoclingo.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

Issue

The template currently contains the file:

https://github.com/potassco/python-project-template/blob/master/docs/_custom/css/mkdoclingo.css

This means that every project that starts with the template overrides the css provided by mkdoclingo.

One such example is:

code.doc-clingo-symbol-predicate::after {
    content: "predicate";
    color: #ca91bf
}

which creates a label predicate. This label is used to show that something is a predicate and currently occurs in front of every link to a predicate in the table of contents (TOC).

Having the entire word predicate in front of every link is very verbose and takes up much of the space reserved for the TOC, resulting in unnecessary line breaks.

Additionally, this forces a very specific color.

For this reason the same css in mkdoclingo looks like this

code.doc-clingo-symbol-predicate::after {
    content: "P";
    color: var(--doc-symbol-predicate-fg-color);
}

Here, the content is only P and the color is applied dynamically from a variable.

Solution

I think the file should be removed entirely. In most cases, mkdoclingo should be responsible for the styling of the sections it provides. Only if custom styling is absolutely necessary/wanted should parts of mkdoclingo be overridden.

Lingua principale
Python
Stelle
6
Fork
5
Nessuna PR unita negli ultimi 30g

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di potassco/python-project-template

Tutte le issue di potassco/python-project-template

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.