https://github.com/wuxiaobai24/f3m
A frontmatter based markdown manager
https://github.com/wuxiaobai24/f3m
Last synced: 2 months ago
JSON representation
A frontmatter based markdown manager
- Host: GitHub
- URL: https://github.com/wuxiaobai24/f3m
- Owner: wuxiaobai24
- License: gpl-3.0
- Created: 2020-07-12T06:54:42.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2022-02-11T01:53:34.000Z (over 3 years ago)
- Last Synced: 2025-02-26T00:47:52.832Z (3 months ago)
- Language: JavaScript
- Size: 331 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
f3m
===
A frontmatter based markdown manager.
[](https://oclif.io)
[](https://npmjs.org/package/f3m)
[](https://npmjs.org/package/f3m)
[](https://github.com/wuxiaobai24/f3m/blob/master/package.json)
* [Usage](#usage)
* [Commands](#commands)
# Usage
```sh-session
$ npm install -g f3m
$ f3m COMMAND
running command...
$ f3m (-v|--version|version)
f3m/0.0.3 linux-x64 node-v12.16.3
$ f3m --help [COMMAND]
USAGE
$ f3m COMMAND
...
```
# Commands
* [`f3m add [PATH]`](#f3m-add-path)
* [`f3m config [SUBCOMMAND]`](#f3m-config-subcommand)
* [`f3m dump [PATH]`](#f3m-dump-path)
* [`f3m help [COMMAND]`](#f3m-help-command)
## `f3m add [PATH]`
Add post(s)
```
USAGE
$ f3m add [PATH]
DESCRIPTION
...
parse post frontmatter into database.
```
_See code: [src/commands/add.js](https://github.com/wuxiaobai24/f3m/blob/v0.0.3/src/commands/add.js)_
## `f3m config [SUBCOMMAND]`
Show and set config
```
USAGE
$ f3m config [SUBCOMMAND]
OPTIONS
-e, --encoding=encoding set encoding config
-f, --frontmatter=frontmatter set frontmatter type config
-n, --name=name name to print
DESCRIPTION
...
f3m config set -f yaml -c utf8
f3m config show # or f3m config
```
_See code: [src/commands/config.js](https://github.com/wuxiaobai24/f3m/blob/v0.0.3/src/commands/config.js)_
## `f3m dump [PATH]`
Describe the command here
```
USAGE
$ f3m dump [PATH]
OPTIONS
-n, --name=name name to print
DESCRIPTION
...
Extra documentation goes here
```
_See code: [src/commands/dump.js](https://github.com/wuxiaobai24/f3m/blob/v0.0.3/src/commands/dump.js)_
## `f3m help [COMMAND]`
display help for f3m
```
USAGE
$ f3m help [COMMAND]
ARGUMENTS
COMMAND command to show help for
OPTIONS
--all see all commands in CLI
```
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v3.1.0/src/commands/help.ts)_