Artikel-Verzeichnis
Vorwort
Dieses Mal, die Projektanforderungen zu schreiben Schnittstellen-Dokumentation, ein Blog verwendet Abschlag Syntax oft, diese Zeit zu schreiben Interface-Dokumentation mit Abschlag, um die Erfahrung zu nutzen, um einige Zusammenfassung zu tun. Leute mich nicht zu faul sein, manchmal immer angezogen, ich fühle er sich mit ihnen sehr vertraut ist, ist nicht unbedingt wirklich praktisch. Noch viel zu lernen, und mehr summieren, um sich zu bereichern.
Abschlag Datei Basisgrammatik
1.markdown Einführung
- Sie können mit Markdown ein Texteditor in einer Markup-Sprache, eine einfache Markup-Syntax geschrieben ist, kann es den Klartextinhalt ein bestimmtes Format hat machen.
- Abschlag hat eine Reihe von abgeleiteten Version, Abschlag für erweiterte Funktionen (wie Tabellen, Fußnoten, eingebettete HTML, etc.), diese Eigenschaften des ursprünglichen Abschlags haben nicht, sie lassen mehr Abschlag in das Format konvertierte, zum Beispiel LaTeX, Docbook . Abschlag erweiterte Version des berühmteren Abschlags Extra, Multimark, Maruku und so weiter. Diese derivativen Versionen auf beide Werkzeug basierten, wie Pandoc oder auf Websites wie GitHub und Wikipedia, auf der grundlegenden Syntax kompatibel, aber es gibt einige Änderungen in der Grammatik und Rendering.
- Markdown - Syntax prägnant, leicht zu erlernen, und mächtiger als reiner Text, so gibt es eine Menge Leute es verwenden , um einen Blog zu schreiben. Die weltweit beliebtesten Blog - Plattformen wie Wordpress und große CMS Joomla, Drupal kann eine gute Unterstützung für Markdown sein. Herausgeber des Blog - Plattform Geistes und Typechos vollständig Abschlag.
Für das Schreiben von Dokumentation und auf „README.md“ Dateinamen im folgende Verzeichnis Software gespeichert. Auszug - Baidu Enzyklopädie
2. Funktionstastenkombinationen
Rückgängig: Ctrl/Command+ Z
Redo: Ctrl/Command+ Y
Bold: Ctrl/Command+ B
kursiv: Ctrl/Command+ I
Titel: Ctrl/Command+ Shift+ H
ungeordnete Liste: Ctrl/Command+ Shift+ U
geordnete Liste: Ctrl/Command+ Shift+ O
Checkliste: Ctrl/Command+ Shift+ C
geben Sie den Code: Ctrl/Command+ Shift+ K
Link einfügen: Ctrl/Command+ Shift+ L
Bild einfügen: Ctrl/Command+ Shift+ G
finden: Ctrl/Command+ F
ersetzen: Ctrl/Command+G
Shortcuts Quick Facts
Funktion | Shortcuts |
---|---|
Rückgängig | Strg + Z |
Redo | Strg + Y |
fett | Strg + B |
kursiv | Strg + I |
Überschrift | Strg + H |
ungeordnete Liste | Strg + U |
Geordnete Liste | Strg + O |
Kontroll-Liste | Strg + C |
Code eingeben | Strg + G |
Link einfügen | Strg + L |
Bild einfügen | Strg + G |
suchen | Strg + F |
ersetzen | Strg + G |
Zitat | Strg + Q |
Lift Titel | Strg + H |
horizontale | Strg + R |
3.markdown Basisgrammatik
3.1 Klassifizierung Titel
Rational erstellen einen Titel , um Hilfe zu kompilieren. 1 ist direkt eingegeben #, und Pressen spaceder Titelstufe 1 erzeugt.
Eingang 2 #und drücken spacenach der Erzeugung der Stufe 2 des Titels. Und so weiter, Abschlag unterstützt derzeit sechs Titel.
Wirkung im wesentlichen wie folgt:
Parsen der HTML folgt:
Vorder # -Zeichen, mit Text zurück bzw. h1-h6 kann der Figur ist ersichtlich, dass nur die Aufmerksamkeit auf h6, einen Raum hinter dem #
Empfohlene Adressen zwei Abschläge Online - Bearbeitung verwendet werden kann , Echtzeit - Effekte anzuzeigen:
https://www.zybuluo.com/mdeditor
https://tool.oschina.net/markdown/
3.2 den Textstil ändern
normaler Text
Betonte (tilt) Text
hervorgehoben (tilt) text
Bold Text
in Fettschrift
Fett gedruckten Text Neigung
gekippt fett gedruckten Text
Tagged Text
Löschen Text
zitiert Text
Die folgenden zwei geschrieben, können Sie in einem freundlichen CSDN Compiler lösen:
H 2 O flüssig ist
2 10 Operationsergebnisse 1024
3.3 wunderschön Trennlinie
Wenn das Dokument zu schreiben, ist die Trennlinie von wesentlicher Bedeutung. * Trennlinie kann gemacht werden , - diese drei Symbole zeigt jedes Symbol die Art der mindestens drei _ (Stern, minus, unten).
注意:
Jedes Symbol hat mindestens drei oder mehr (einschließlich 3) und nicht kontinuierlich zu sein braucht, kann ein Raum sein, aber die Zeile kann nicht auf andere Inhalte oder die Trennlinie zwischen ungültig ist .
3.4 Link einfügen
Unterstützt zwei Arten von Links: interne Leitung und Parametertyp, egal welche Art, ist der Link-Text mit [eckigen Klammern] markiert.
- In-the-line - Link
verbindet
Abschlag , die mit einigen gemischt werden können, wie zum Beispiel: Linkliste - Parametric Link
[param]: http://www.baidu.com ,
die ein Parameter ist die Formel [param] link, Methode Umschreiben nicht verwendet wird , die hauptsächliche Verwendung der obigen Ausführungsform , daß
- Faule Menschen Link
Markdown - Unterstützung mit einem relativ kurzen URLs werden automatisch in Links Formularverarbeitung und E-Mail, solange die Verwendung <> Wrap, Markdown wird es automatisch in einen Link drehen. Natürlich können Sie auch direkt schreiben, sondern auch bilden , wie Links automatisch angezeigt werden kann.
Wie zum Beispiel: www.baidu.com oder <www.baidu.com> ein solcher Ansatz nicht wirksam auf CSDN.
3.5 Bild einfügen
- Bild einfügen Internet
Grammatikregeln:
![图片描述信息](图片网络存储路径)
Hinweis: Diese Beschreibung Bild kann nicht schreiben.
Normale Größe Bild
Bilder mit den Maßen:
Zentriert Bild:
Zentriert und Bilder mit einer Größe von:
主要pic_center和后边设置尺寸的“=”之间有空格
- In dem lokalen Bildlink
3.6 Referenzen
Vor dem zitierten Text und >
Zeichen, und einen Raum sein kann, wenn nur ein Eingabe - >
Symbol wird eine leere Referenz hat, kann es mehrere sein.
注意
: Das ist Klammer rechten Winkel in Englisch, beachten Sie den Raum
-
Die grundlegende Verwendung von
Verwendung , wie unten dargestellt:
-
Nest zitierte
Referenzen , weil es ein Block, in der Theorie ist, sollte das sein , was beispielsweise eingesetzt werden kann,: Überschriften, Listen, Referenzen usw., wie unten dargestellt:
Der obigen Code ein wenig ändert es, alle zusammen ein Referenzetikett, wird es eine gute Referenz, gibt es auch Hinweise dort zitierte, dass verschachtelte Referenzen es keine andere Schrift zitiert?
Die Figur zu sehen ist, Ihnen ein Angebot auf einer Schicht aus verschachtelten Referenzen wollen, nur noch eine> theoretisch unlimitiert, ich weiß nicht so sehr eine ganze Aufmerksamkeit: mehrere Ebenen von verschachtelten> ist nicht erforderlich kontinuierlich zusammen in einer Reihe , so lange wie möglich, und in der Mitte eines Raumes zu ermöglichen, aber um gut aussehen, oder einen guten Job zu tun , es zu veröffentlichen.
3.7 Liste
- Ungeordnete Liste
mit*
,+
,-
ungeordnete Liste.
Hinweis: Es muss ein Raum hinter dem Zeichen dafür sein, eine Rolle spielen indent.
一个tab键,会有不同效果
- Punkt 3
- Punkt 3
- Punkt 3
- Punkt 3
- Punkt 3
- Punkt 3
- Punkt 3
- Punkt 3
- Punkt 3
- Punkt 3
- Punkt 3
- Eine geordnete Liste von
Zahlen und nur eine Periode repräsentiert eine geordnete Liste.
Hinweis: hinter der englischen Zeit muss einen Raum haben, den Einzug der Rolle.
- Listen und andere Elemente gemischte
Listen nicht nur allein oder mit anderer Markdown - Syntax für die gemischten Einsatz, wie zum Beispiel verwendet werden kann: Titel, Referenz, Code, Fliesen, etc. interessiert ist, kann selbst ausprobieren.
3.8 Flucht
Js Flucht mit im wesentlichen der gleichen Syntax
Codeblock 3.9
Das ist wichtiger, Schreib Schnittstellen - Dokumentation, muss es einige Code - Abfrage - Parameter und Rückgabeparameter sein, diesmal Notwendigkeit zu demonstrieren.
Mit drei englischen Formel Backquote ( '), wenn die Schreib Kommentare, Zitate nach dem anti geschrieben werden
unten dargestellt:
- Block, der HTML - Code enthält ,
in dem der Code - Block, &, <und> werden in HTML - Entitäten automatisch konvertiert, in einer solchen Art und Weise , so dass Sie leicht in den HTML - Quellcode mit der Verwendung von Beispielen für die Abschriften eingefügt, einfach kopieren und einfügen, die restlichen Abschlag werden Ihnen helfen, behandeln.
注意
: Jane in dem Buchblock nicht unterstützt HTML.
Beispiele sind wie folgt:
3.10 Erstellen einer Tabelle
- Eine einfache Tabelle wird so erstellt:
Projekt | Wert |
---|---|
Computer | 1600 $ |
Handy | $ 12 |
Katheter | $ 1 |
- Einstellen Inhalt Zentrum, links und Aufenthaltsrecht
zu verwenden ,:---------:
das Zentrum
zu verwenden:----------
links zu Hause
Verwendung----------:
Wohnrecht
Die erste Spalte | Die zweite Spalte | Die dritte Spalte |
---|---|---|
Die erste Spalte der Text zentriert | Die zweite Spalte von Text geht auf der rechten Seite | Die dritte Spalte von Text Left |
Gemeinsame grundlegende Grammatik, im Grunde das ist alles, beherrschte die oben gesagt, Abschlag fast genug.
Dieser Artikel Referenz Links:
- CSDN offizielle Hilfedokumentation
- https://www.cnblogs.com/liugang-vip/p/6337580.html
- https://blog.csdn.net/u014061630/article/details/81359144
Schreiben Sie Ihren eigenen Blog ist einfach zu vergessen , um Dinge zu erinnern, und die andere ist die Zusammenfassung ihrer Arbeit, in der Hoffnung , ihre eigenen Anstrengungen, um es besser zu machen, wir arbeiten zusammen , um die Fortschritte!
Wenn Sie Fragen haben, sprechen Sie bitte mit jedem, dem Code Fragen, begrüßt mich großen Gott zu korrigieren!
In Ihrem Traum Paar Flügel, können sie frei in den Himmel fliegen!