У моїй документації щодо репозиторіїв Githubs я хочу представити структуру дерева каталогів наступним чином:
Чи є спосіб зробити це за допомогою ароматної націнки Github, крім того, щоб просто створити її за допомогою мистецтва ascii?
Тому в основному це питання подобається , але мені цікаво, чи існує конкретне рішення для github.
Відповіді:
Не безпосередньо, ні. Вам доведеться вручну створити його і вкласти в себе. Якщо припустити, що ви використовуєте поле * nix локально і використовуєте utf, тоді дерево буде його генерувати красиво (я вважаю, що саме це породило приклад, який ви використовували вище).
Якщо припустити, що ви маєте на увазі readme.mdяк ціль документації, тоді, я думаю, єдиним способом, яким ви можете це автоматизувати, був би git-попередній коміт, який запускався treeта вбудовував його у ваш файл readme. Ви хочете зробити різницю, щоб переконатись, що ви оновлювали readme, лише якщо вихідні дані змінювалися.
Отже, якщо ви ведете окремі документи на сторінках github, то, що ви могли б зробити, це перейти на використання jekyll (або іншого генератора) локально та самостійно просувати статичні сторінки. Тоді ви можете потенційно реалізувати потрібні зміни як плагін / скрипт оболонки * / ручні зміни (якщо вони не будуть сильно відрізнятися), або скористатися тим самим методом, що описаний вище.
* Якщо ви інтегруєте його в гачок коміту, ви можете уникнути додавання додаткових кроків до зміни своїх сторінок.
treeкоманду за допомогою Homebrew , тобто brew install tree. Потім із каталогу, який я хотів представляти, я побіг, tree . >> tree.txtа потім скопіював та відредагував текст у своєму файлі README.md. Зробив саме те, що мені потрібно!
Я вирішив проблему таким чином:
tree в bash.Приклад
Приклад
4. Перегляньте результати і будьте щасливі =)
Я написав невеликий сценарій, який робить фокус:
#!/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}"
$ tree
.
├── dir1
│ ├── file11.ext
│ └── file12.ext
├── dir2
│ ├── file21.ext
│ ├── file22.ext
│ └── file23.ext
├── dir3
├── file_in_root.ext
└── README.md
3 directories, 7 files
$ ./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)
(Посилання не видно в Stackoverflow ...)
Дерево проектівЯ зробив модуль вузла для автоматизації цього завдання: mddir
вузол mddir "../relative/path/"
Для встановлення: npm install mddir -g
Щоб сформувати націнку для поточного каталогу: mddir
Для генерації для будь-якого абсолютного шляху: mddir / absolute / path
Щоб створити для відносного шляху: mddir ~ / Documents / whatever.
Файл md генерується у вашому робочому каталозі.
На даний момент ігнорує node_modules та папки .git.
Якщо ви отримуєте повідомлення про помилку 'node \ r: такого файлу чи каталогу немає', проблема полягає в тому, що ваша операційна система використовує різні закінчення рядків, і mddir не може їх проаналізувати, якщо ви явно не встановите для Unix стиль закінчення рядка. Зазвичай це стосується Windows, а також деяких версій Linux. Встановлення закінчень рядків у стилі Unix повинно виконуватися в глобальній папці mddir npm.
Отримати шлях до папки bin npm за допомогою:
npm config get prefix
Cd в цю папку
заваріть встановити dos2unix -
dos2unix lib / node_modules / mddir / src / mddir.js
Це перетворює закінчення рядків на Unix замість Dos
Потім запустіть як зазвичай за допомогою: вузол mddir "../relative/path/".
|-- .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
node_modules/mddir/src/каталогу? Наприклад, я хотів би запустити node ~./src > dir-struct.txtз мого каталогу проекту та вставити вміст dir-struct.txt безпосередньо у свою відмітку.
Найкращий спосіб зробити це - оточити своє дерево потрійними зворотними позначками для позначення блоку коду. Для отримання додаткової інформації див. Документи щодо розмітки: http://daringfireball.net/projects/markdown/syntax#code
Ви можете використовувати теги <pre>, як це робив я в одному зі своїх проектів .
Ви також можете перевірити це розширене дерево пакет. Його можна використовувати як додаток командного рядка, використовуючи node> = 6.x.
Це дуже схоже на, treeале також має можливість налаштування максимальної глибини в дереві, що є однією з жахливих речей. Також ви можете фільтрувати за допомогою .gitignoreфайлу.
Жодне з наведеного вище рішення не працювало для мене повністю на моєму mac.
Найкраще рішення, яке я знайшов, - скористатися створеною тут утилітою.
https://github.com/michalbe/md-file-tree
Після встановлення утиліти npm install md-file-tree -gви можете просто запустити, щоб отримати дерево всіх файлів
md-file-tree . > README.md
Ось корисне, git aliasщо працює для мене.
git config --global alias.tree '! git ls-tree --full-name --name-only -t -r HEAD | sed -e "s/[^-][^\/]*\// |/g" -e "s/|\([^ ]\)/|-- \1/"'
Ось результат git tree
jonavon@XPS13:~/projects/roman-numerals$ git tree
.gitignore
pom.xml
src
|-- main
| |-- java
| | |-- com
| | | |-- foxguardsolutions
| | | | |-- jonavon
| | | | | |-- AbstractFile.java
| | | | | |-- roman
| | | | | | |-- Main.java
| | | | | | |-- Numeral.java
| | | | | | |-- RomanNumberInputFile.java
| | | | | | |-- RomanNumeralToDecimalEvaluator.java
|-- test
| |-- java
| | |-- com
| | | |-- foxguardsolutions
| | | | |-- jonavon
| | | | | |-- roman
| | | | | | |-- InterpretSteps.java
| | | | | | |-- RunCukesTest.java
| |-- resources
| | |-- com
| | | |-- foxguardsolutions
| | | | |-- jonavon
| | | | | |-- roman
| | | | | | |-- Interpret.feature
| | |-- sample-input.txt
Порівнянна treeкоманда
jonavon@XPS13:~/projects/roman-numerals$ tree -n
.
├── pom.xml
├── src
│ ├── main
│ │ └── java
│ │ └── com
│ │ └── foxguardsolutions
│ │ └── jonavon
│ │ ├── AbstractFile.java
│ │ └── roman
│ │ ├── Main.java
│ │ ├── Numeral.java
│ │ ├── RomanNumberInputFile.java
│ │ └── RomanNumeralToDecimalEvaluator.java
│ └── test
│ ├── java
│ │ └── com
│ │ └── foxguardsolutions
│ │ └── jonavon
│ │ └── roman
│ │ ├── InterpretSteps.java
│ │ └── RunCukesTest.java
│ └── resources
│ ├── com
│ │ └── foxguardsolutions
│ │ └── jonavon
│ │ └── roman
│ │ └── Interpret.feature
│ └── sample-input.txt
└── target
├── classes
│ └── com
│ └── foxguardsolutions
│ └── jonavon
│ ├── AbstractFile.class
│ └── roman
│ ├── Main.class
│ ├── Numeral.class
│ ├── RomanNumberInputFile.class
│ └── RomanNumeralToDecimalEvaluator.class
├── generated-sources
│ └── annotations
└── maven-status
└── maven-compiler-plugin
└── compile
└── default-compile
├── createdFiles.lst
└── inputFiles.lst
30 directories, 17 files
Очевидно, що дерево має кращі результати, але я хотів би, щоб він використовував мій файл .gitignore. Щоб мій скомпільований вміст не відображався
Проста treeкоманда зробить цю роботу. Наприклад: tree -o readme.mdнадрукує деревоподібну структуру поточного робочого каталогу та запише в неї readme.md. Потім відкрийте файл readme.md в одному з текстових редакторів, наприклад Sublime, і оберніть його вміст парою потрійних зворотних позначок (`` '').
FYI: можливо, вам доведеться заварити дерево встановлення в OSX, якщо воно ще не встановлене. У Linux та Windows це просто має працювати нормально. Також у вікнах, можливо, доведеться замінити дефіс на косу риску.
Сподіваюся, це допоможе.
Якщо ви працюєте з Windows, напишіть tree /fвсередині каталогу, ви хочете досягти цього в командному рядку. Це повинно зробити вашу роботу. Ви можете скопіювати та вставити висновок на розмітку, оточену мої потрійні зворотні галочки, тобто '' '{деревоподібна структура тут}' '' '
Мені просто подобається генерувати його за допомогою UTF-8 і пов'язувати з кожним файлом і папкою, щоб дуже легко переміщатися. Будь ласка, подивіться на приклад тут .
Для тих, хто хоче швидко вирішити:
Існує спосіб отримати вихід на консоль, подібний до виводу з дерева, ввівши в термінал таку команду:
ls -R YOURFOLDER | grep ':$' | sed -e 's/:$//' -e 's/[^\/]*\//| /g' -e 's/| \([^|]\)/|–– \1/g'
Ця альтернатива згадується в цій документації: https://wiki.ubuntuusers.de/tree/
Тоді висновок можна скопіювати та інкапсулювати всередині .md-файлу з тиками зворотного блоку коду, як зазначено у відповіді Джонатаса до н.е.
Але майте на увазі, що він також виводить усі папки модулів вузлів у проекті вузла. А на дереві ви можете зробити щось подібне
tree -I node_modules
виключити папку вузлових модулів.
Вставте дерево команд у bash.
Також є DOS-комнанд і "дерево". Ви можете відобразити шляхи до каталогу та файли у кожному підкаталозі за допомогою команди:
tree /F