hackmdio / hackmdio/hackmd-io-issues

Allow to include special hackmd links in github READMEs

Aperta
#145 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub
Lingua principale
Nessun dato sulla lingua
Stelle
40
Fork
9
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

**Is your feature request related to a problem? Please describe.**
A README on github supports markdown, but is quite limited, e.g. no mermaid, no slides mode, etc...

**Describe the solution you'd like**
I'd like to include a link to hackmd.io with a URL param to one or more markdown files in my github repository, so when somebody clicks and opens it, hackmd fetches the content from github and displays it in hackmd (slide mode or whatever mode) ...without the necessity for a browser extension.

**Describe alternatives you've considered**
- telling people to not install the browser extension
- writing my stuff in markdown and then having an empty README.md on github with a single link to my markdown document, but that removes the markdown content from my repository :/

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Direzione di ricerca

Inizia esaminando i vincoli di rendering di GitHub README e il modo in cui HackMD gestisce gli URL che fanno riferimento ai file Markdown del repository. Definisci come devono essere rappresentati uno o più file e modalità di visualizzazione, quindi verifica che un link README apra il contenuto richiesto in HackMD senza richiedere un’estensione del browser.

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

Valutazione

Stack tecnologico
markdown
Ambito
documentation
Tipo di issue
Funzionalità
Difficoltà
5/5
Tempo stimato
Più di una settimana
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.