r-markdown-cli 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 relic6
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,61 @@
+# r-markdown-cli
+
+Rich Markdown (`rmd`) is a toolchain and core engine for parsing, validating, previewing, and building `.rmd` files. It provides a standard way to process rich text content, featuring a local preview server and multiple built-in themes.
+
+## Installation
+
+We recommend installing the CLI tool globally via npm:
+
+```bash
+npm install -g r-markdown-cli
+```
+
+## Usage
+
+Once installed, you can use the `rmd` command directly in your terminal. Here is an overview of the core commands:
+
+### Preview & Build
+
+- **Start Local Preview**: Launches a local development server to preview `.rmd` files in real-time.
+  ```bash
+  rmd open example.rmd --port 3000
+  ```
+
+- **Compile to HTML**: Statically compiles `.rmd` files into HTML with support for themes and bundling modes.
+  ```bash
+  # Available themes: default, notion-like, paper, tech-dark
+  # Available modes: self-contained, cdn, split
+  rmd build example.rmd --mode self-contained --theme tech-dark --out dist/demo.html
+  ```
+
+### Parse & Validate
+
+- **Output AST**: Parses the file and outputs the Abstract Syntax Tree (AST) in JSON format.
+  ```bash
+  rmd parse example.rmd
+  ```
+
+- **Validate Structure**: Validates the `.rmd` file against the built-in schema to ensure compliance.
+  ```bash
+  rmd validate example.rmd
+  ```
+
+### AI Integration
+
+- **Initialize AI Skill**: Installs Rich Markdown processing skills for your AI assistants (e.g., Codex, Claude).
+  ```bash
+  rmd init --ai claude
+  rmd init --ai all
+  ```
+
+## More Options
+
+To see all available commands and flags:
+
+```bash
+rmd --help
+```
+
+## License
+
+This project is licensed under the MIT License. See the [LICENSE](./LICENSE) file for details.