https://github.com/ho-cooh/markdowngenerator
Generate .md with source files and directory [The project is currently discontinued]
https://github.com/ho-cooh/markdowngenerator
Last synced: 7 months ago
JSON representation
Generate .md with source files and directory [The project is currently discontinued]
- Host: GitHub
- URL: https://github.com/ho-cooh/markdowngenerator
- Owner: HO-COOH
- Created: 2020-01-30T01:57:04.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2020-02-07T15:44:34.000Z (over 6 years ago)
- Last Synced: 2025-02-10T02:45:30.944Z (over 1 year ago)
- Language: C++
- Homepage:
- Size: 9.77 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# MarkdownGenerator
Generate .md with source files and directory
## Example
Suppose in the current directory, we have files strctures like the following:
```
./
/include
a.h
b.h
/src
a.cpp
b.cpp
main.cpp
/documentation
c.txt
d.txt
/details
additional_details.txt
```
The generated ``markdown`` will be something like this:
```markdown
## include
- a.h
- b.h
## src
- a.cpp
- b.cpp
## documentation
- c.txt
- d.txt
### details
- additional_details.txt
```
The program will generate a ``n level header`` for each ``n level directory``. And an ``entrace`` for each file.
**TODO**: Add support for reading the content and description in the actual files.
## Aditional Note
This is a further practice for utilizing ``std::filesystem`` in ``C++17``. Additionaly, using a tree data structure.