Czy istnieje rozwidlenie przeceny, które pozwala odwoływać się do innych plików, na przykład plik dołączony? W szczególności chcę utworzyć osobny plik przeceny z linkami, które często wywołuję, ale nie zawsze (nazywam to B.md), a następnie, gdy odsyłam przez odniesienie w pliku md, który piszę (A.md), jak to, aby pobrać link z innego pliku (B.md), a nie z końca bieżącego pliku (A.md).

Krótka odpowiedź brzmi: nie. Długa odpowiedź brzmi: tak. :-)

Markdown został zaprojektowany, aby umożliwić ludziom pisanie prostego, czytelnego tekstu, który można łatwo przekształcić w prosty znacznik HTML. Tak naprawdę nie układa dokumentu. Na przykład nie ma realnego sposobu wyrównywania obrazu do prawej lub lewej strony. Jeśli chodzi o twoje pytanie, nie ma polecenia markdown, które zawierałoby pojedynczy link z jednego pliku do drugiego w dowolnej wersji markdown (o ile mi wiadomo).

Pandoc jest najbliżej tej funkcjonalności . Pandoc pozwala łączyć pliki w ramach transformacji, co pozwala łatwo renderować wiele plików w jedno wyjście. Na przykład, jeśli tworzysz książkę, możesz mieć następujące rozdziały:

01_preface.md
02_introduction.md
03_why_markdown_is_useful.md
04_limitations_of_markdown.md
05_conclusions.md

Możesz je scalić, wykonując polecenie w tym samym katalogu:

pandoc *.md > markdown_book.html

Ponieważ pandoc scali wszystkie pliki przed wykonaniem tłumaczenia, możesz dołączyć swoje linki do ostatniego pliku w następujący sposób:

01_preface.md
02_introduction.md
03_why_markdown_is_useful.md
04_limitations_of_markdown.md
05_conclusions.md
06_links.md

Więc część twojego 01_preface.mdmoże wyglądać tak:

I always wanted to write a book with [markdown][mkdnlink].

Część twojej 02_introduction.mdmoże wyglądać tak:

Let's start digging into [the best text-based syntax][mkdnlink] available.

Tak długo, jak twój ostatni plik zawiera wiersz:

[mkdnlink]: http://daringfireball.net/projects/markdown

... to samo polecenie użyte wcześniej wykona scalenie i konwersję, jednocześnie włączając to łącze w całym tekście. Tylko upewnij się, że zostawiłeś pustą linię lub dwie na początku tego pliku. Dokumentacja pandoc mówi, że dodaje pustą linię między plikami, które są scalane w ten sposób, ale nie działało to dla mnie bez pustej linii.

Chciałbym tylko wspomnieć, że można użyć catpolecenia, aby połączyć pliki wejściowe przed ich potokowaniem, markdown_pyco ma taki sam efekt, jak w pandocprzypadku wielu plików wejściowych.

cat *.md | markdown_py > youroutputname.html

działa prawie tak samo jak powyższy przykład pandoc dla Python wersji Markdown na moim Macu.

Możesz faktycznie użyć Markdown Preprocessor ( MarkdownPP ). Korzystając z hipotetycznego przykładu książki z innych odpowiedzi, tworzysz .mdpppliki reprezentujące twoje rozdziały. Te .mdpppliki mogą następnie korzystać z !INCLUDE "path/to/file.mdpp"dyrektywy, która działa rekursywnie zastępującej dyrektywę z zawartością pliku wskazanej w końcowej produkcji.

chapters/preface.mdpp
chapters/introduction.mdpp
chapters/why_markdown_is_useful.mdpp
chapters/limitations_of_markdown.mdpp
chapters/conclusions.mdpp

Potrzebny byłby wtedy plik index.mdppzawierający:

!INCLUDE "chapters/preface.mdpp"
!INCLUDE "chapters/introduction.mdpp"
!INCLUDE "chapters/why_markdown_is_useful.mdpp"
!INCLUDE "chapters/limitations_of_markdown.mdpp"
!INCLUDE "chapters/conclusions.mdpp"

Aby renderować książkę, po prostu uruchom preprocesor na index.mdpp:

$ markdown-pp.py index.mdpp mybook.md

Nie zapomnij spojrzeć na readme.mdppw MarkdownPP repozytorium ekspozycja preprocesora funkcje dostosowane do większych projektów dokumentacji.

Moim rozwiązaniem jest użycie m4. Jest obsługiwany na większości platform i jest zawarty w pakiecie binutils.

Najpierw dołącz changequote()do pliku makro , aby zmienić znaki cudzysłowu na preferowane (domyślnie jest to ''). Makro jest usuwane podczas przetwarzania pliku.

changequote(`{{', `}}')
include({{other_file}})

W wierszu polecenia:

m4 -I./dir_containing_other_file/ input.md > _tmp.md
pandoc -o output.html _tmp.md

Niedawno napisałem coś takiego w Node o nazwie markdown-include, która pozwala na dołączanie plików markdown ze składnią w stylu C, na przykład:

#include "my-file.md"

Wierzę, że to dobrze pasuje do pytania, które zadajesz. Wiem, że to stary, ale chciałem go przynajmniej zaktualizować.

Możesz dołączyć to do dowolnego pliku zniżki. Ten plik może również zawierać więcej włączeń, a tagowanie-dołączenie utworzy wewnętrzny link i wykona całą pracę za Ciebie.

Możesz pobrać go za pośrednictwem npm

npm install -g markdown-include

Multimarkdown ma to natywnie. Nazywa to transkluzją plików :

{{some_other_file.txt}}

wystarczy. Dziwne imię, ale zaznacza wszystkie pola.

Używam includes.txtpliku ze wszystkimi moimi plikami we właściwej kolejności i wykonuję pandoc w następujący sposób:

pandoc -s $(cat includes.txt) --quiet -f markdown -t html5 --css pandoc.css -o index.html

Działa jak marzenie!

W rzeczywistości możesz używać \input{filename}i \include{filename}które są komendami lateksowymi, bezpośrednio w Pandoc, ponieważ obsługuje prawie wszystkie htmli latexskładnię.

Ale uwaga, dołączony plik będzie traktowany jako latexplik. Ale można skompilować markdownTO latexz Pandoxłatwością.

Asciidoc ( http://www.methods.co.nz/asciidoc/ ) jest tak naprawdę zniżką na sterydy. Ogólnie rzecz biorąc, Asciidoc i Markdown będą wyglądać bardzo podobnie i raczej łatwo je zmienić. Ogromna korzyść asciidoc nad obniżki jest obsługa obejmuje już inne pliki asciidoc ale również dla dowolnego formatu chcesz. Możesz nawet częściowo dołączyć pliki na podstawie numerów linii lub znaczników do dołączonych plików.

Dołączanie innych plików jest naprawdę ratowaniem życia podczas pisania dokumentów.

Możesz na przykład mieć plik asciidoc z taką zawartością:

// [source,perl]
// ----
// include::script.pl[]
// ----

i zachowaj swoją próbkę w script.pl

I jestem pewien, że będziesz się zastanawiać, więc tak, Github obsługuje również asciidoc.

Myślę, że lepiej przyjąć nową składnię dołączania plików (więc nie zepsują się blokami kodu, myślę, że włączenie stylu C jest całkowicie niepoprawne) i napisałem małe narzędzie w Perlu, nazywając go cat.pl, ponieważ działa jakcat ( cat a.txt b.txt c.txtscali się trzy pliki), ale łączy pliki głęboko , a nie w szerokość . Jak używać?

$ perl cat.pl <your file>

Szczegółowa składnia to:

• rekurencyjne obejmują pliki: @include <-=path=
• wystarczy dołączyć jeden: %include <-=path=

Może poprawnie obsługiwać pętle dołączania plików (jeśli a.txt <- b.txt, b.txt <- a.txt, to czego oczekujesz?).

Przykład:

a.txt:

a.txt

    a <- b

    @include <-=b.txt=

a.end

b.txt:

b.txt

    b <- a

    @include <-=a.txt=

b.end

perl cat.pl a.txt > c.txt, c.txt:

a.txt

    a <- b

    b.txt

        b <- a

        a.txt

            a <- b

            @include <-=b.txt= (note：won't include, because it will lead to infinite loop.)

        a.end

    b.end

a.end

Więcej przykładów na https://github.com/district10/cat/blob/master/tutorial_cat.pl_.md .

Napisałem również wersję Java, która ma identyczny efekt (nie taki sam, ale zamknięty).

Jestem właściwie zaskoczony, że nikt na tej stronie nie zaoferował żadnych rozwiązań HTML. O ile rozumiem, pliki MarkDown mogą zawierać szeroką część (jeśli nie wszystkie) znaczników HTML. Wykonaj następujące kroki:

1. Od tutaj : umieścić swoje pliki Przecena w <span style="display:block"> ... </span>tagach mieć pewność, będą renderowane jako obniżki. Masz wiele innych właściwości stylu, które możesz dodać. Ten, który lubię to text-align:justify.

2. Od tutaj : Dołącz pliki w głównym pliku za pomocą<iframe src="/path/to/file.md" seamless></iframe>

PS1. to rozwiązanie nie działa na wszystkich silnikach / renderach MarkDown. Na przykład Typora poprawnie renderuje pliki, ale nie Visual Studio Code. Byłoby wspaniale, gdyby inni mogli podzielić się swoimi doświadczeniami z innymi platformami. Szczególnie chciałbym usłyszeć o GitHub i GitLab ...

PS2. Po dalszych badaniach wydaje się, że występują poważne problemy z niekompatybilnością, które prowadzą do nieprawidłowego renderowania na wielu platformach, w tym w Typorze, GitHub i kodzie Visual Studio. Nie używaj tego, dopóki ich nie rozwiążę. Nie usunę odpowiedzi tylko ze względu na dyskusję i jeśli możesz podzielić się swoimi opiniami.

PS3. Aby dokładniej zbadać ten problem, zadałem to pytanie tutaj na StackOverflow i tutaj na Reddit .

PS4. Po kilku badaniach doszedłem do wniosku, że na razie AsciiDoc jest lepszą opcją dla dokumentacji. Ma wbudowaną funkcję włączania, jest renderowany przez GitHub, a główne edytory kodu, takie jak Atom i vscode, mają rozszerzenia do podglądu na żywo. Można użyć Pandoc lub innych narzędzi do automatycznej konwersji istniejącego kodu MarkDown na AsciiDoc z niewielkimi zmianami.

PS5. Innym lekkim językiem znaczników z wbudowaną funkcją włączania jest reStructuredText. .. include:: inclusion.txt Standardowo ma składnię. Istnieje również edytor ReText z podglądem na żywo.

Wiem, że to stare pytanie, ale nie widziałem żadnych odpowiedzi na ten efekt: Zasadniczo, jeśli używasz Markdown i Pandoc do konwersji pliku na pdf, w swoich danych yaml u góry strony, możesz dołączyć coś takiego:

---
header-includes:
- \usepackage{pdfpages}
output: pdf_document
---

\includepdf{/path/to/pdf/document.pdf}

# Section

Blah blah

## Section 

Blah blah

Ponieważ pandoc używa lateksu do konwersji wszystkich dokumentów, header-includessekcja wywołuje pakiet pdfpages. Następnie, jeśli dodasz \includepdf{/path/to/pdf/document.pdf}, wstawi wszystko, co jest zawarte w tym dokumencie. Ponadto można w ten sposób dołączyć wiele plików pdf.

Jako bonus zabawy, a to tylko dlatego, że często używam Markdown, jeśli chcesz dołączyć pliki inne niż Markdown, na przykład pliki lateksowe. Zmodyfikowałem nieco tę odpowiedź . Powiedz, że masz plik markdown markdown1.md:

---
title: Something meaning full
author: Talking head
---

I dwa dodatkowe dokumenty z lateksu1, które wyglądają tak:

\section{Section}

Profundity.

\subsection{Section}

Razor's edge.

I kolejny, document2.tex, który wygląda następująco:

\section{Section

Glah

\subsection{Section}

Balh Balh

Zakładając, że chcesz dołączyć document1.tex i document2.tex do markdown1.md, po prostu zrób to dla markdown1.md

---
title: Something meaning full
author: Talking head
---

\input{/path/to/document1}
\input{/path/to/document2}

Uruchom nad nim pandoc, np

w terminalu pandoc markdown1.md -o markdown1.pdf

Twój końcowy dokument będzie wyglądał mniej więcej tak:

Coś oznacza pełne

Gadająca głowa

Sekcja

Głębia.

Sekcja

Krawędź żyletki.

Sekcja

Glah

Sekcja

Balh Balh

Używam Marked 2 na Mac OS X. Obsługuje następującą składnię do dołączania innych plików.

<<[chapters/chapter1.md]
<<[chapters/chapter2.md]
<<[chapters/chapter3.md]
<<[chapters/chapter4.md]

Niestety nie można tego karmić pandocem, ponieważ nie rozumie on składni. Jednak napisanie skryptu usuwającego składnię w celu utworzenia wiersza poleceń pandoc jest dość łatwe.

Kolejne rozwiązanie po stronie klienta oparte na HTML, wykorzystujące markdown-it i jQuery . Poniżej znajduje się małe opakowanie HTML jako dokument główny, który obsługuje nieograniczoną liczbę plików przeceny, ale nie obejmuje zagnieżdżonych. Wyjaśnienie znajduje się w komentarzach JS. Obsługa błędów jest pomijana.

<script src="/markdown-it.min.js"></script>
<script src="/jquery-3.5.1.min.js"></script>

<script> 
  $(function() {
    var mdit = window.markdownit();
    mdit.options.html=true;
    // Process all div elements of class include.  Follow up with custom callback
    $('div.include').each( function() {
      var inc = $(this);
      // Use contents between div tag as the file to be included from server
      var filename = inc.html();
      // Unable to intercept load() contents.  post-process markdown rendering with callback
      inc.load(filename, function () {
        inc.html( mdit.render(this.innerHTML) );
      });
  });
})
</script>
</head>

<body>
<h1>Master Document </h1>

<h1>Section 1</h1>
<div class="include">sec_1.md</div>
<hr/>
<h1>Section 2</h1>
<div class="include">sec_2.md</div>

IMHO, Możesz uzyskać wynik, łącząc pliki wejściowe * .md, takie jak:

$ pandoc -s -o outputDoc.pdf inputDoc1.md inputDoc2.md outputDoc3.md