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

Add Dockerfile for creating a docker container #197

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add Dockerfile for creating a docker container #197

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 5 additions & 0 deletions Dockerfile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
FROM node:lts

RUN npm install -g markdown-toc

ENTRYPOINT ["/usr/local/bin/markdown-toc"]
16 changes: 16 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,22 @@ Assuming you want to add a TOC to README.md:
2. Edit README.md and insert the following line where you want the TOC inserted:<br />`<!-- toc -->`
3. `$ markdown-toc -i README.md`

## Usage with Docker

First, clone the repository and create the image using the command:

```sh
docker build -t markdown-toc:latest .
```

Then, use the Docker "run" command to launch the container (assuming that the file contains a line with `<!-- toc -->`):

```sh
docker run -it --rm -v "$(pwd):/src" -i /src/README.md
```

The command above assumes that the `README.md` file is in the current working directory. If not, replace `$(pwd)` with the path to the directory where the markdown file is.

## CLI

```
Expand Down