https://github.com/hfcred/documentation

Source code for the documentation website for my tools and projects
https://github.com/hfcred/documentation

astrojs documentation starlight

Last synced: 5 months ago
JSON representation

Source code for the documentation website for my tools and projects

• Host: GitHub
• URL: https://github.com/hfcred/documentation
• Owner: hfcRed
• License: mit
• Created: 2024-03-24T08:23:45.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-09-30T20:02:02.000Z (over 1 year ago)
• Last Synced: 2025-04-14T18:47:21.104Z (about 1 year ago)
• Topics: astrojs, documentation, starlight
• Language: MDX
• Homepage: https://docs.hfcred.dev/
• Size: 3.02 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          


# Documentation

Source code for the [documentation website](https://docs.hfcred.dev/) for my tools and projects

[![Built with Starlight](https://astro.badg.es/v2/built-with-starlight/medium.svg)](https://starlight.astro.build)

![chrome_zA9cpG8vtS](https://github.com/hfcRed/Documentation/assets/101019309/b8985dfd-f76f-4768-b0b3-f42c58ec3437)



---

## Running locally

If you dont already have NVM installed, download the latest ``nvm-setup.zip`` from [here](https://github.com/coreybutler/nvm-windows/releases), then extract the zip and run the installer.

If you are on a Unix based machine like Linux or MacOS, run the following command to install NVM:

```bash

curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.7/install.sh | bash

```

You can verify that NVM is installed by running:

```bash

nvm --version

```

After installing NVM run the following commands in the directory of the project:

* ``nvm use`` to switch to the required Node version.

  * If the required version is not installed, you will be prompted to run the ``nvm install`` command.

  * After installing the required version, run ``nvm use`` again

* ``npm install`` to install the dependencies

To start testing locally you can use the following commands:

* ``npm run dev`` to start a local dev server at ``localhost:4321``

* ``npm run build`` to create a build of the website

* ``npm run preview`` to preview the build at ``localhost:4321``