Gibt es eine Möglichkeit, eine Verzeichnisstruktur in einem GITHUB README.md zu repräsentieren?

In meinem Githubs repos Dokumentation möchte ich darstellen, einen Verzeichnis-Baum-Struktur wie diese:

Gibt es eine Möglichkeit, das zu tun, mit Github flavoured markdown, außer nur die Erstellung von ascii-Kunst?

Also im Grunde wie diese Frageaber ich Frage mich, ob es gibt ein github-spezifische Lösung.

InformationsquelleAutor der Frage | 2014-06-02

9

Nicht direkt, Nein. Würden Sie zur hand haben, erstellen Sie es und legte es in sich. Vorausgesetzt, Sie sind mit einem *nix-box vor Ort und die Verwendung der utf, dann Baum generiert es schön (ich glaube, das ist das, was erzeugt das Beispiel, das Sie oben verwendet).

Vorausgesetzt, du meinst die readme.md wie die Dokumentation Ziel, dann denke ich, die einzige Möglichkeit, die Sie automatisieren können, wäre es ein git-pre-commit-hook, der lief tree und integrierte es in Ihre readme-Datei. Sie wollen, um zu tun, einen diff zu machen, dass Sie nur aktualisiert die readme-Datei, wenn die Ausgabe geändert.

Otoh, wenn Sie die Aufrechterhaltung der separaten docs via github-Seiten, dann, was Sie könnte tun, ist switch der Verwendung von jekyll (oder ein anderer generator) lokal und drücken Sie die statischen Seiten selbst. Dann könnten Sie möglicherweise implementieren die änderungen, die Sie möchten, entweder als plugin /shell-Skript* /manuelle änderungen (wenn Sie nicht viel variieren), oder verwenden Sie die gleiche Methode wie oben.

*Wenn Sie die Integration in ein commit-hook, Sie können, vermeiden Sie irgendwelche zusätzlichen Schritte zum ändern Ihrer Seiten.

InformationsquelleAutor der Antwort Oliver Matthews

Ich ein kleines Skript geschrieben, dass der trick funktioniert:

#!/bin/bash

#File: tree-md

tree=$(tree -tf --noreport -I '*~' --charset ascii $1 |
       sed -e 's/| \+/ /g' -e 's/[|`]-\+/*/g' -e 's:\(* \)\(\(.*/\)\([^/]\+\)\):\1[\4](\2):g')

printf "# Project tree\n\n${tree}"

Beispiel:

Ursprüngliche Baum-Befehl:

$ tree
.
├── dir1
│   ├── file11.ext
│   └── file12.ext
├── dir2
│   ├── file21.ext
│   ├── file22.ext
│   └── file23.ext
├── dir3
├── file_in_root.ext
└── README.md

3 directories, 7 files

Markdown-Baum-Befehl:

$ ./tree-md .
# Project tree

.
 * [tree-md](./tree-md)
 * [dir2](./dir2)
   * [file21.ext](./dir2/file21.ext)
   * [file22.ext](./dir2/file22.ext)
   * [file23.ext](./dir2/file23.ext)
 * [dir1](./dir1)
   * [file11.ext](./dir1/file11.ext)
   * [file12.ext](./dir1/file12.ext)
 * [file_in_root.ext](./file_in_root.ext)
 * [README.md](./README.md)
 * [dir3](./dir3)

Gerenderte Ergebnis:

(Links sind nicht sichtbar, in Stackoverflow...)

Projekt Baum

Baum-md
dir2
- file21.ext
- file22.ext
- file23.ext
dir1
- file11.ext
- file12.ext
file_in_root.ext
README-Datei.md
dir3

InformationsquelleAutor der Antwort Simon

12

Machte ich ein node-Modul zum automatisieren dieser Aufgabe: mddir

Nutzung

Knoten mddir "../relative/Pfad/"

Installieren: npm install mddir -g

Generieren Preisabschlag zum aktuellen Verzeichnis: mddir

Generieren, die für alle absoluten Pfad: mddir /absoluter/Pfad

Generieren, die für einen relativen Pfad: mddir ~/Dokumente/was auch immer.

Md-Datei generiert wird, die in Ihrem Arbeitsverzeichnis.

Derzeit ignoriert node_modules, und .git Ordner.

Fehlerbehebung

Wenn Sie erhalten die Fehlermeldung "node\r: Keine solche Datei oder das Verzeichnis', das Problem ist, dass das Betriebssystem verwendet, verschiedene Zeilenenden und mddir kann nicht analysieren, ohne Sie explizit festlegen des Zeilenende-Stil zu Unix. Diese Regel wirkt sich auf Windows, aber auch einigen Linux-Versionen. Einstellung Zeilenenden zu Unix-Stil durchgeführt werden, die innerhalb der mddir npm global-Ordner "bin".

Zeilenenden fix

Bekommen npm-bin-Ordner-Pfad mit:

npm config get prefix

Cd in diesen Ordner

brew install dos2unix

dos2unix lib/node_modules/mddir/src/mddir.js

Diese konvertiert Zeilenenden zu Unix statt Dos

Dann normal laufen mit: Knoten mddir "../relative/Pfad/".

Beispiel erzeugten markdown-Datei-Struktur 'directoryList.md'
```
    |-- .bowerrc
    |-- .jshintrc
    |-- .jshintrc2
    |-- Gruntfile.js
    |-- README.md
    |-- bower.json
    |-- karma.conf.js
    |-- package.json
    |-- app
        |-- app.js
        |-- db.js
        |-- directoryList.md
        |-- index.html
        |-- mddir.js
        |-- routing.js
        |-- server.js
        |-- _api
            |-- api.groups.js
            |-- api.posts.js
            |-- api.users.js
            |-- api.widgets.js
        |-- _components
            |-- directives
                |-- directives.module.js
                |-- vendor
                    |-- directive.draganddrop.js
            |-- helpers
                |-- helpers.module.js
                |-- proprietary
                    |-- factory.actionDispatcher.js
            |-- services
                |-- services.cardTemplates.js
                |-- services.cards.js
                |-- services.groups.js
                |-- services.posts.js
                |-- services.users.js
                |-- services.widgets.js
        |-- _mocks
            |-- mocks.groups.js
            |-- mocks.posts.js
            |-- mocks.users.js
            |-- mocks.widgets.js
```
InformationsquelleAutor der Antwort John Byrne
9

Bekam ich resolver das problem auf diese Weise:
1. Insert-Befehl tree in der bash.
  
  Beispiel
2. Erstellen Sie eine README-Datei.md bei github repository und kopieren Seite des bash -
3. Einfügen markdown-code
  
  Beispiel
4. Finden Sie in der Ausgabe und glücklich sein =)
InformationsquelleAutor der Antwort Jonathas B. C.
6

Der beste Weg, dies zu tun ist, setzen Sie Ihren Baum in der drei backticks, um eine code-block. Weitere Informationen finden Sie in der markdown-Dokumentation:
http://daringfireball.net/projects/markdown/syntax#code

InformationsquelleAutor der Antwort joe sepi
1

Die Sie verwenden können, <pre> - tags wie ich in einem meiner Projekte.

InformationsquelleAutor der Antwort borngeek
0

Wenn Sie mit Atom-editor, mit diesem Paket können Sie einfach schreiben ASCII-Bäume: ascii-Baum

InformationsquelleAutor der Antwort Ramtin Soltani
0

Können Sie auch überprüfen, diese Baum-extended Paket. Es kann verwendet werden, als ein Kommandozeilen-app, indem Sie mithilfe von Knoten - >= 6.x.

Es ist sehr ähnlich zu tree hat aber auch die Möglichkeit, die Konfiguration der max tief im Baum, dass ist eine der schrecklichen Dinge. Sie können auch filter mit .gitignore Datei.

InformationsquelleAutor der Antwort Raúl Otaño