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.

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

Adds more information about embedded YAML in the README. #6

Closed
wants to merge 1 commit into from
Closed
Changes from all commits
Commits
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
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@
CLI tool for loading markdown files into a SQLite database.

YAML embedded in the markdown files will be used to populate additional columns.
See the [pandoc documentation](https://pandoc.org/MANUAL.html#metadata-variables)
for more information. Only caveat is that the embedded YAML has to be
terminated with `---` instead.

Usage: markdown-to-sqlite [OPTIONS] DBNAME TABLE PATHS...

Expand Down