Skip to content

Commit 61edd95

Browse files
committed
More surgery
- Remove .eslintignore and .prettierignore files - Convert from an mdast util to a remark plugin for easier use with unified.js processors - Rename package to remark-astro - Rename data field from `astromd` to `astro` for consistency and easier typing and pronunciation - Remove documentation of supported syntax from README. We will develop better user documentation elsewhere
1 parent ff49e5a commit 61edd95

14 files changed

+810
-63
lines changed

.eslintignore

-1
This file was deleted.

.gitignore

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
node_modules
22
/coverage
3-
/*.js
3+
/index.js
44
*.d.ts
55
.eslintcache
66
*.tgz

.prettierignore

-1
This file was deleted.

README.md

+5-13
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
[![codecov](https://codecov.io/gh/nasa-gcn/mdast-astromd/branch/main/graph/badge.svg?token=3ID7X7XNNQ)](https://codecov.io/gh/nasa-gcn/mdast-astromd)
1+
[![codecov](https://codecov.io/gh/nasa-gcn/remark-astro/branch/main/graph/badge.svg?token=3ID7X7XNNQ)](https://codecov.io/gh/nasa-gcn/remark-astro)
22

3-
# mdast-astromd
3+
# remark-astro
44

5-
This is a plugin for [mdast](https://github.com/syntax-tree/mdast) for parsing Astro Flavored Markdown, a dialect of [Markdown](https://www.markdownguide.org) for rapid astronomy communications.
5+
This is a plugin for [remark](https://github.com/remarkjs/remark) for parsing Astro Flavored Markdown, a dialect of [Markdown](https://www.markdownguide.org) for rapid astronomy communications.
66

77
Astro Flavored Markdown detects dates, times, sky coordinates, and bibliographic references. Astro Flavored Markdown data is tagged in the [mdast](https://github.com/syntax-tree/mdast) syntax tree for later enrichment.
88

@@ -11,7 +11,7 @@ An Astro Flavored Markdown node is just an mdast [Text](https://github.com/synta
1111
```ts
1212
export interface AstroText extends Text {
1313
data: {
14-
astromd: {
14+
astro: {
1515
/** Astro Flavored Markdown data type */
1616
type: string
1717
/** Normalized value */
@@ -21,12 +21,4 @@ export interface AstroText extends Text {
2121
}
2222
```
2323

24-
Astro Flavored Markdown supports the following types.
25-
26-
## datetime
27-
28-
A UTC date with an optional time, normalized to [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601).
29-
30-
## gcn-circular
31-
32-
A reference to a GCN Circular.
24+
For supported syntax, see the [src/replacements](src/replacements) directory. In each direcetory there is a file called `test.md` illustrating the Markdown syntax and a file called `test.json` containing the resulting syntax tree.

0 commit comments

Comments
 (0)