Skip to content

Commit 476b7ab

Browse files
committed
docs(hnstd): update and rename: docs.md -> hnstd.md
1 parent f98b74c commit 476b7ab

2 files changed

Lines changed: 8 additions & 4 deletions

File tree

deno.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
},
1818
"exclude": [
1919
"./typedoc.config.json",
20-
"./docs.md",
20+
"./hnstd.md",
2121
"./.github/",
2222
"./scripts/",
2323
"./CHANGELOG.md"
@@ -30,7 +30,7 @@
3030
"tasks": {
3131
"docs": "deno task docs:std && deno task docs:api",
3232
"docs:api": "deno run --allow-read --allow-env --allow-run typedoc src/function.ts src/portRemap.ts jsx.ts --html ./docs/api --skipErrorChecking --options typedoc.config.json --readme README.md --name hnxml.js",
33-
"docs:std": "deno run --allow-read --allow-env --allow-run typedoc index.ts --html ./docs/ --skipErrorChecking --options typedoc.config.json --readme docs.md --name 'Hnxml Standard'",
33+
"docs:std": "deno run --allow-read --allow-env --allow-run typedoc index.ts --html ./docs/ --skipErrorChecking --options typedoc.config.json --readme hnstd.md --name 'Hnxml Standard'",
3434
"fmt": "deno fmt",
3535
"release": "deno task fmt && deno task changelog && deno task updateDenoJson && deno task fmt",
3636
"changelog": "pnpx changelogen --release --no-commit --no-tag",

docs.md renamed to hnstd.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,12 @@
33
[![JSR Badge](https://jsr.io/badges/@modernschoolproject/hnxml)](https://jsr.io/@modernschoolproject/hnxml)
44
[![Github Badge](https://img.shields.io/badge/Github-hnxml-black?logo=github)](https://github.com/Modern-School/hnxml)
55

6-
Hnxml Standard (hnstd) is a TypeScript-based XML schema specification for
7-
Hacknet extensions, and it is defined by the source code of `hnxml.js`.
6+
> [!WARNING]\
7+
> Note: This project is in heavy development and is not ready for production
8+
> use.
9+
10+
Hnxml Standard is a TypeScript-based XML schema specification for Hacknet
11+
Extension, and it is defined by `hnxml.js`.
812

913
The homepage of this site is Hnxml Standard. You can access hnxml.js API Docs
1014
through [hnxml.js API Docs](https://hnxml.js.org/api).

0 commit comments

Comments
 (0)