isaacalmedia/docs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update README.md

Browse source
This commit is contained in:
Isaac Greene 2025-08-24 03:48:30 +02:00
parent f796c94d20
commit f48d96a7b5
1 changed files with 4 additions and 38 deletions
Download patch file Download diff file Expand all files Collapse all files

42
README.md
View file

@ -1,41 +1,7 @@
# Website
# Docs for Isaacal Media
This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
This repo has the source files for [docs.isaac.run](https://docs.isaac.run). To build them, you'll need Docusaurus and Node.js.
## Installation
I'll update this at most once per week. Less if I don't feel like it or there aren't any changes.
```bash
yarn
```
## Local Development
```bash
yarn start
```
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
## Build
```bash
yarn build
```
This command generates static content into the `build` directory and can be served using any static contents hosting service.
## Deployment
Using SSH:
```bash
USE_SSH=true yarn deploy
```
Not using SSH:
```bash
GIT_USER=<Your GitHub username> yarn deploy
```
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
Docusaurus is MIT licensed. Node.js is mostly MIT, but partly BSD, Apache, and a couple others. All of my documentation is CC BY-SA 4.0.