dis
github.com/ythosa/disguise
go get github.com/ythosa/disguise
dis

github.com/ythosa/disguise

GitHub Projects Markdown Generator

by Ruslan Babin

v0.0.0-20200727182457-fd7fbd5ee71c (see all)License:Apache-2.0
go get github.com/ythosa/disguise
Readme

disguise

CI/CD Codacy Badge CodeFactor


gopher :3

Install

  • From sources:

    • Clone this repo: git clone https://github.com/Ythosa/disguise;
    • Build project by writing in terminal: make.
  • From github tag:

    • Download the latest binaries of this project.

Description

Disguise is CLI tool for generation markdown with list of github repository directories and files. Can be used for creation repositories issues about the process of documenting the code.

CLI options could be:

  • -url "<github_repo_url>" - identify repositories should have documentation
  • -ext "<file_extension>" - identify files should have documentation
  • -ignore "<some_dir_name_in_repo>" - identify dirs shouldn't have documentation
  • -file-prefix "<some_markdown_syntax>" - specifies the prefix of files in the output markdown (default: - [ ])
  • -folder-prefix "<some_markdown_syntax>" - specifies the prefix of folders in the output markdown (default: #####)
  • -help - returns CLI help and info

Usage example

Let's create an issue about the process of documenting this project, but I don't want to document the checks folder. We just need to write this line in the terminal.

./disguise -url "https://github.com/ythosa/disguise" -ext ".go" -ignore "src/checks" -folder-prefix "*" -file-prefix "    *"

Output example:

FAQ

Q: How can I help to develop this project?
A: You can put a ⭐ :3


Copyright 2020 Ythosa

GitHub Stars

11

LAST COMMIT

2yrs ago

MAINTAINERS

0

CONTRIBUTORS

2

OPEN ISSUES

2

OPEN PRs

0
VersionTagPublished
v0.0.0-20200727182457-fd7fbd5ee71c
1yr ago
v0.0.0-20200725155832-bd2ceeaef80c
2yrs ago
v0.0.0-20200725152848-c75a776f2eb4
2yrs ago
v0.0.0-20200725152313-945a0cbcb32a
2yrs ago
No alternatives found
No tutorials found
Add a tutorial