Jaki plik ma rozszerzenie .md i jak powinienem je edytować?

878

Na GitHub kilka projektów ma README.mdpliki. Wygląda jak prosty format pliku do wyrażania tekstu i zdjęć.

Wydaje mi się, że gdzieś jest wyjaśnienie edytora lub składni.

Gdzie mogę znaleźć wprowadzenie do .mdplików?

Lai Yu-Hsuan
źródło
38
Wydaje mi się, że jest to dowód na korzyść użycia .markdownrozszerzenia, choć jest ono tak okropnie długie ...
endolith
7
Oto link, który może ci pomóc -> Rozszerzenie pliku .MD
Vipin Kr. Singh
1
MarkPad to przyjemna aplikacja do edycji MarkDown w systemie Windows. Przedstawia podgląd zmian.
skjoshi
1
Użytkownik może wypróbować MarkView , rozszerzenie Chrome do edycji i przeglądania pliku przeceny w przeglądarce.
swcool
1
Pełny przewodnik, który pomoże Ci zacząć markdown: blog.wax-o.com/2014/04/… . Powinieneś spróbować napisać przecenę, aby na żywo wizualizować wynik (za pomocą aplikacji takiej jak mouapp.com ). Czy wiesz, że składnia postu i komentarza Stackoverflow opiera się na Markdown? :) stackoverflow.com/editing-help
fabien

Odpowiedzi:

732

Markdown to format pliku tekstowego. Rozszerzenia .mdi .markdownsą tylko plikami tekstowymi zapisanymi w składni Markdown . Jeśli masz Readme.mdrepozytorium, GitHub wyświetli zawartość na stronie głównej repozytorium. Przeczytaj dokumentację:

Możesz edytować Readme.mdplik w samym GitHub. Kliknij Readme.md, znajdziesz przycisk edycji. Możesz wyświetlić podgląd swoich zmian, a nawet zatwierdzić je stamtąd.

Ponieważ jest to plik tekstowy, do jego edycji i modyfikacji można używać programu TextEdit (Mac) lub dowolnego innego edytora tekstu. Istnieją wyspecjalizowane edytory, które automatycznie analizują znaczniki podczas pisania i generują podgląd, podczas gdy inne stosują różne kolory składni i dekoracje do wyświetlanego tekstu. Jednak w obu przypadkach zapisany plik jest nadal czytelnym plikiem tekstowym.

Jeśli chcesz utworzyć mdplik z podglądem i nie chcesz instalować żadnych specjalnych edytorów, możesz użyć edytorów online, takich jak dillinger.io i stackedit.io . Zapewniają podgląd na żywo. Możesz także wyeksportować swoje pliki na Dysk Google lub Dropbox .

Dikei
źródło
27
Uważam też, że podstawowe wyjaśnienie Githuba jest bardzo przydatne jako szybkie wprowadzenie.
Voo
2
W systemie Windows możesz użyć programu WordPad, aby skorzystać z formatowania i ułatwić czytanie.
G O'Rilla,
4
@ GO'Rilla, IMHO unikaj WordPada jak zarazy, chyba że piszesz sobie notatki, których nigdy nikomu nie udostępnisz. To, co dodaje do pliku .txt, może siać spustoszenie w innych edytorach (vim, Notepad ++ itp.). Znacznie lepiej jest pracować w formacie zwykłego tekstu podczas pracy z .txt i używać edytora tekstu lub programu Acrobat w przypadku plików tekstowych innych niż .txt, takich jak .doc i .pdf.
labirynt
1
czy możemy dodać obrazy lub link w pliku .md ... czy to możliwe?
Raphael
1
@ user1645290 Tak, jest to możliwe. patrz
B-GangsteR
87

Jeśli szukasz edytora, sugeruję skorzystanie z http://dillinger.io/ . Jest to prosty edytor tekstowy oparty na przeglądarce, który może renderować Markdown w locie.

Jeśli jednak wolisz aplikację i korzystasz z systemu OS X, możesz wypróbować Mou . Jest całkiem dobry i pełen przykładów.

sirLisko
źródło
2
Wydaje się, że wrócił do życia?
GuiSim,
5
Chciałbym zaproponować http://dillinger.io/ , kolejny naprawdę fajny edytor tekstowy oparty na przeglądarce. Pozwala także na połączenie Dropbox, Github i dysku Google.
sirLisko
Łącze Notatnika w tej odpowiedzi powoduje pobranie pliku RAR. Dlaczego nie ma strony internetowej, czy nie powiedziałeś, że to edytor oparty na przeglądarce?
evanrmurphy
ten link nie jest już ważny
Carlos Pliego,
Wskazując tylko, że nie jest to pełna odpowiedź na pytanie. Nie wyjaśniasz, czym jest .md, tylko jak można go edytować
Zoe
44

GitHub za Atom edytor tekstu posiada tryb podglądu na żywo dla plików przecen.

Skrót klawiaturowy to CTRL+SHIFT+M.

To może być aktywowana z edytora używając CTRL+SHIFT+Mklucza wiążące i jest obecnie włączone .markdown, .md, .mkd, .mkdown, oraz .ronplików.

wprowadź opis zdjęcia tutaj

Feckmore
źródło
33

Edytor tekstu Microsoft Visual Studio Code ma wbudowaną obsługę plików .md zapisanych w składni Markdown.

Składnia jest automatycznie kodowana kolorami w pliku .md, a okno podglądu renderowanego znacznika można wyświetlić, naciskając Shift+Ctrl+V(Windows) lub Shift+Cmd+V(Mac).

Aby zobaczyć je obok siebie, przeciągnij kartę podglądu na prawą stronę edytora lub użyj zamiast tego Ctrl+K V(Windows) lub Cmd+K V(Mac).

wprowadź opis zdjęcia tutaj

VS Code wykorzystuje zaznaczoną bibliotekę do analizowania i ma domyślnie włączoną obsługę Github Flavored Markdown , ale nie wyświetla wbudowanego emoji Github, tak jak robi to edytor tekstowy Atom Github .

Ponadto, obsługa VS Code ma kilka wtyczek obniżających cenę dostępnych dla rozszerzonej funkcjonalności.

Feckmore
źródło
Jeśli zamiast tego używasz programu Visual Studio 2015, zobacz moją odpowiedź poniżej.
bytedev
1
Uwaga - możesz kliknąć prawym przyciskiem myszy plik readme> otworzyć podgląd
Chris Halcrow
15

Rozszerzenie „ .md ” odnosi się do plików Markdown .

Jeśli nie chcesz instalować aplikacji do odczytu ich w tym formacie, możesz po prostu użyć TextEdit lub samego Xcode , aby otworzyć ją na komputerze Mac.

W każdym innym systemie operacyjnym powinieneś być w stanie otworzyć go za pomocą dowolnego edytora tekstu , chociaż zgodnie z oczekiwaniami nie zobaczysz go w formacie Markdown .

kodeburn
źródło
4
Właściwie będzie zobaczyć go w formacie Markdown. Nie zobaczysz tego jednak jako pogrubienia, kursywy, wcięć i bloków kodu.
Wyścigi lekkości na orbicie
14

Tak, tylko Markdown o smaku GitHub . Dołączenie pliku README do repozytorium pomoże innym szybko ustalić, o co chodzi i jak go zainstalować. Bardzo pomocne do uwzględnienia w repozytoriach.

esilvas
źródło
5
Doceniony. Przez „jeden” w „włączeniu jednego do repozytorium” należy rozumieć „plik README w dowolnym formacie”, a nie tylko „plik README.md”. Ale pytanie dotyczy ogólnie plików „.md”, a nie plików README w ogóle. Ta odpowiedź nie ma zatem znaczenia dla pytania. Również dwuznaczność z „jednym” może sprawić, że czytelnik pomyśli, że pliki README firmy Markdown są z konieczności lepsze niż inne pliki README, co jest błędne.
Rory O'Kane,
1
Dokonałem zmiany określonej w poprzednim komentarzu, ponieważ ma to sens i myślę, że mogłoby to pomóc w pomyłce. Nie sądzę jednak, aby była to bardzo dobra odpowiedź, ponieważ nie dodaje nic nowego, co jest istotne. To pytanie nie dotyczy plików README, dotyczy rozszerzenia .md. Nie ma powodu, aby dodawać tę odpowiedź sześć tygodni po tym, jak zaakceptowana odpowiedź podała te same informacje.
Erick Robertson
5

Stack Edit to internetowy edytor przecen z możliwością zapisywania na Dysku Google i DropBox.

Philip
źródło
5

Markdown to po prostu plik tekstowy, który opcjonalnie ma .mdlub .markdownrozszerzenia. Można go przekonwertować na HTML. Aby poznać składnię Markdown, sprawdź

Markit o smaku GitHub .

Możesz użyć dowolnego edytora tekstu do obniżania cen. Jeśli jesteś sublime textużytkownikiem, możesz sprawdzić Markdown Previewwtyczkę, która wyświetli renderowaną zawartość przeceny w przeglądarce i aktualizuje za każdym razem, gdy zmienisz plik przeceny.

Niektóre z internetowych edytorów przecen

Fizer Khan
źródło
3

Sugeruję StackEdit . Jest to prosty edytor WISIWIG. Możesz użyć zarówno edytora, jak i składni. Jest tam szybka składnia pomocy dla markdown. Cofnij / ponów, komentarze, GoogleDrive, połączenie Dropbox.

Romeno
źródło
2

markable.in to bardzo fajne narzędzie online do edycji składni Markdown

użytkownik1337432
źródło
2

Jeśli tworzysz pliki .md dla swoich rozwiązań .NET, polecam rozszerzenie Markdown Editor programu Visual Studio 2015, ponieważ ma panel podglądu, dzięki czemu możesz zobaczyć swoje zmiany w czasie rzeczywistym.

EDYCJA : To również powinno teraz działać z Visual Studio 2017.

bytedev
źródło
0

Najłatwiejszą rzeczą do zrobienia, jeśli nie masz czytnika, jest otwarcie pliku MD za pomocą edytora tekstowego, a następnie zapisanie pliku MD jako pliku HTML, a następnie dwukrotne kliknięcie, aby wyświetlić go w przeglądarce.

richardwendrock
źródło
Działa to tylko wtedy, gdy masz wtyczkę odczytującą pliki .md.
Brad Bruce
0

.Md oznacza Markdown Text. Zasadniczo jest to po prostu inny typ pliku tekstowego, na przykład .txt

Używam Notepad ++ do ich odczytu i edycji

NocFenix
źródło