steveklabnik/rustdoc

Flag: markdown no TOC

Aperta

#147 aperta il 10 ago 2017

Vedi su GitHub
 (2 commenti) (0 reazioni) (0 assegnatari) (22 fork)github user discovery
E-Mediumbackendhelp wantedquestion

Metriche repository

Star
 (104 stelle)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

Descrizione

This issue is part of https://github.com/steveklabnik/rustdoc/issues/125

--markdown-no-toc: don't generate a table of contents

Using this flag looks like this:

$ rustdoc README.md --markdown-no-toc

When generating documentation from a Markdown file, by default, rustdoc will generate a table of contents. This flag supresses that, and no TOC will be generated.

Should we keep this flag or not?

Guida contributor

Direzione di ricerca
Investigare l'implementazione corrente del flag markdown no toc nel repository rust lang/rust. Cercare discussioni o problemi riguardanti il suo utilizzo. Determinare se il flag è ancora necessario o se esistono alternative migliori. Fornire una raccomandazione con motivazione.
Tech stack
rust
Dominio
documentationcli
Tipo issue
Ricerca
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Meno di 1 ora
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Datata
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Rust
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
70