fs-to-md v0.0.3

fs-to-md

fs-to-md is a command line to for converting a note/blog directory into a markdown directory (same directory structure).

Most Jamstack tools like gatsby only takes in markdown files, sometimes my markdown notes contains image files and other code files, by converting them to markdown allows my notes to be properly displayed online.

• Usage
• Commands

Usage

$ npm install -g fs-to-md
$ fs-to-md COMMAND
running command...
$ fs-to-md (--version)
fs-to-md/0.0.3 darwin-arm64 node-v18.12.1
$ fs-to-md --help [COMMAND]
USAGE
  $ fs-to-md COMMAND
...

Commands

• fs-to-md convert [IGNOREFILE]
• fs-to-md help [COMMAND]
• fs-to-md plugins
• fs-to-md plugins:install PLUGIN...
• fs-to-md plugins:inspect PLUGIN...
• fs-to-md plugins:install PLUGIN...
• fs-to-md plugins:link PLUGIN
• fs-to-md plugins:uninstall PLUGIN...
• fs-to-md plugins:uninstall PLUGIN...
• fs-to-md plugins:uninstall PLUGIN...
• fs-to-md plugins update

fs-to-md convert [IGNOREFILE]

describe the command here

USAGE
  $ fs-to-md convert [IGNOREFILE] -s <value> -t <value> [-i <value>]

FLAGS
  -i, --ignorefile=<value>  Ignore File Path
  -s, --source=<value>      (required) Source Directory
  -t, --target=<value>      (required) Target Directory

DESCRIPTION
  describe the command here

EXAMPLES
  $ fs-to-md convert --source /Users/huakun/Documents/Dev/fs-docs-v2/notes --target ./abc

See code: dist/commands/convert.ts

fs-to-md help [COMMAND]

Display help for fs-to-md.

USAGE
  $ fs-to-md help [COMMAND] [-n]

ARGUMENTS
  COMMAND  Command to show help for.

FLAGS
  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION
  Display help for fs-to-md.

See code: @oclif/plugin-help

fs-to-md plugins

List installed plugins.

USAGE
  $ fs-to-md plugins [--core]

FLAGS
  --core  Show core plugins.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ fs-to-md plugins

See code: @oclif/plugin-plugins

fs-to-md plugins:install PLUGIN...

Installs a plugin into the CLI.

USAGE
  $ fs-to-md plugins:install PLUGIN...

ARGUMENTS
  PLUGIN  Plugin to install.

FLAGS
  -f, --force    Run yarn install with force flag.
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Installs a plugin into the CLI.

  Can be installed from npm or a git url.

  Installation of a user-installed plugin will override a core plugin.

  e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
  will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
  the CLI without the need to patch and update the whole CLI.

ALIASES
  $ fs-to-md plugins add

EXAMPLES
  $ fs-to-md plugins:install myplugin 

  $ fs-to-md plugins:install https://github.com/someuser/someplugin

  $ fs-to-md plugins:install someuser/someplugin

fs-to-md plugins:inspect PLUGIN...

Displays installation properties of a plugin.

USAGE
  $ fs-to-md plugins:inspect PLUGIN...

ARGUMENTS
  PLUGIN  [default: .] Plugin to inspect.

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Displays installation properties of a plugin.

EXAMPLES
  $ fs-to-md plugins:inspect myplugin

fs-to-md plugins:install PLUGIN...

Installs a plugin into the CLI.

USAGE
  $ fs-to-md plugins:install PLUGIN...

ARGUMENTS
  PLUGIN  Plugin to install.

FLAGS
  -f, --force    Run yarn install with force flag.
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Installs a plugin into the CLI.

  Can be installed from npm or a git url.

  Installation of a user-installed plugin will override a core plugin.

  e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
  will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
  the CLI without the need to patch and update the whole CLI.

ALIASES
  $ fs-to-md plugins add

EXAMPLES
  $ fs-to-md plugins:install myplugin 

  $ fs-to-md plugins:install https://github.com/someuser/someplugin

  $ fs-to-md plugins:install someuser/someplugin

fs-to-md plugins:link PLUGIN

Links a plugin into the CLI for development.

USAGE
  $ fs-to-md plugins:link PLUGIN

ARGUMENTS
  PATH  [default: .] path to plugin

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Links a plugin into the CLI for development.

  Installation of a linked plugin will override a user-installed or core plugin.

  e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
  command will override the user-installed or core plugin implementation. This is useful for development work.

EXAMPLES
  $ fs-to-md plugins:link myplugin

fs-to-md plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ fs-to-md plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ fs-to-md plugins unlink
  $ fs-to-md plugins remove

fs-to-md plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ fs-to-md plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ fs-to-md plugins unlink
  $ fs-to-md plugins remove

fs-to-md plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ fs-to-md plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ fs-to-md plugins unlink
  $ fs-to-md plugins remove

fs-to-md plugins update

Update installed plugins.

USAGE
  $ fs-to-md plugins update [-h] [-v]

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Update installed plugins.