Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix in README.MD the markdown Tags #7

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Fix in README.MD the markdown Tags #7

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d169109
Update README.md
VitorDiToro Apr 18, 2018
3c573ee
Update README.md
VitorDiToro Apr 18, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 23 additions & 19 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,36 +2,40 @@
SummarizeMD is a simple Ruby script that generate summary (TOC) for an existing MD document.
Each item of summary is linked to the respective section.

#Usage
## Usage
- download file
- open console
- chmod +x summarizeMD
- ./summarizeMD \<yourfile\>.md



#Output
## Output

In order to preserve original file, the output of the script produce another file prepending generated summary.

$ls
.
..
summarizeMD
readme.md

```bash
$ ls
.
..
summarizeMD
readme.md
```
<br>

./summarizeMD readme.md
$ls
.
..
summarizeMD
readme.md
summarized_readme.md

```bash
$ ./summarizeMD readme.md
```

```bash
$ ls
.
..
summarizeMD
readme.md
summarized_readme.md
```

#Options
## Options

You can launch script with some options (work in progress).

Expand All @@ -47,7 +51,7 @@ Display list of available options.
Display script version.


#License
## License

Copyright (c) 2015 velthune

Expand Down