Skip to content

Commit

Permalink
Update Docs Deps
Browse files Browse the repository at this point in the history
  • Loading branch information
Bwc9876 committed Jan 6, 2025
1 parent be81042 commit 3562b91
Show file tree
Hide file tree
Showing 11 changed files with 2,719 additions and 2,606 deletions.
20 changes: 10 additions & 10 deletions docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,10 @@ Thank you for your interest in contributing to NH Docs! We are excited to have y

Pages in the NH docs are all markdown files. The folder with all the pages is in `src/content/docs`.

- `index.mdx` Is a special file that is the home page of the docs. This is a markdown X file that allows us to use Astro components in the markdown.
- `start-here` is the folder that contains all the pages for the start here section of the docs.
- `getting-started` is the folder that contains all the pages for the getting started section of the docs.
- `reference` is the folder that contains all the pages for the api section of the docs.
- `index.mdx` Is a special file that is the home page of the docs. This is a markdown X file that allows us to use Astro components in the markdown.
- `start-here` is the folder that contains all the pages for the start here section of the docs.
- `getting-started` is the folder that contains all the pages for the getting started section of the docs.
- `reference` is the folder that contains all the pages for the api section of the docs.

Finally, the `schemas` folder contains all the schema pages. You might notice that the schema folder is not present in GitHub. This is because the schema pages are auto-generated from the schema files in `../NewHorizons/Schemas`. In order to edit these you need to edit the C# class they correspond to. More info in the main contributing document found one folder up.

Expand All @@ -23,10 +23,10 @@ One thing to note is the section fenced with `---` at the top of each page. This

If you open this folder (`docs` not the entire repo), VSCode should prompt you to install the recommended extensions. If it doesn't, you can install them manually. The recommended extensions are:

- astro-build.astro-vscode
- davidanson.vscode-markdownlint
- yzhang.markdown-all-in-one
- esbenp.prettier-vscode
- astro-build.astro-vscode
- davidanson.vscode-markdownlint
- yzhang.markdown-all-in-one
- esbenp.prettier-vscode

## How To Add Pages

Expand All @@ -48,8 +48,8 @@ Your images will be automatically optimized when the site is built.

If you want to get a local copy of the site running, you'll need a few programs

- [Node.js](https://nodejs.org/en/)
- [PNPM](https://pnpm.io/)
- [Node.js](https://nodejs.org/en/)
- [PNPM](https://pnpm.io/)

Once you have these installed, you can run the following commands to get the site running locally:

Expand Down
12 changes: 6 additions & 6 deletions docs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,17 +12,17 @@
"format": "prettier --write ."
},
"dependencies": {
"@astrojs/starlight": "^0.28.3",
"astro": "4.16.7",
"@astrojs/starlight": "^0.30.3",
"astro": "5.1.3",
"rehype-external-links": "^3.0.0",
"sharp": "^0.33.5"
},
"devDependencies": {
"@apidevtools/json-schema-ref-parser": "^11.7.2",
"eslint": "^9.13.0",
"@apidevtools/json-schema-ref-parser": "^11.7.3",
"eslint": "^9.17.0",
"eslint-plugin-prettier": "^5.2.1",
"fast-xml-parser": "^4.5.0",
"prettier": "^3.3.3",
"fast-xml-parser": "^4.5.1",
"prettier": "^3.4.2",
"prettier-plugin-astro": "^0.14.1",
"xml-js": "^1.6.11"
}
Expand Down
Loading

0 comments on commit 3562b91

Please sign in to comment.