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

Rename package to @nasa-gcn/afm #1

Merged
merged 1 commit into from
May 14, 2024
Merged
Show file tree
Hide file tree
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
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# remark-rehype-astro-cli
# Astro Flavored Markdown

This is a command-line tool to render Astro Flavored Markdown documents to JSON abstract syntax trees or HTML. Astro Flavored Markdown is a dialect of [Markdown](https://www.markdownguide.org) for rapid astronomy communications. Astro Flavored Markdown detects and enriches dates, times, sky coordinates, and bibliographic references in text.

Expand All @@ -7,7 +7,7 @@ This command-line interface is a thin wrapper around [remark-rehype-astro](https
## Usage

```
Usage: remark-rehype-astro-cli [options] [input]
Usage: afm [options] [input]

Render Astro Flavored Markdown as a JSON syntax tree or as HTML

Expand Down Expand Up @@ -37,7 +37,7 @@ Here is a table:
To render as a JSON syntax tree:

```
$ npx remark-rehype-astro-cli example.md
$ npx afm example.md
{
"type": "root",
"children": [
Expand Down Expand Up @@ -126,7 +126,7 @@ $ npx remark-rehype-astro-cli example.md
To render as HTML:

```
$ npx remark-rehype-astro-cli --html example.md
$ npx afm --html example.md

<h1>Example</h1>
<p>Here is a table:</p>
Expand Down
6 changes: 3 additions & 3 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
{
"name": "@nasa-gcn/remark-rehype-astro-cli",
"name": "@nasa-gcn/afm",
"version": "1.1.1",
"description": "Command-line tool to render Astro Flavored Markdown documents to JSON abstract syntax trees or HTML",
"main": "index.js",
"bin": {
"remark-rehype-astro-cli": "index.js"
"afm": "index.js"
},
"scripts": {
"prepare:husky": "husky install",
Expand All @@ -14,7 +14,7 @@
},
"repository": {
"type": "git",
"url": "github:nasa-gcn/remark-rehype-astro-cli"
"url": "github:nasa-gcn/afm"
},
"license": "Apache-2.0",
"keywords": [],
Expand Down
Loading