๐Ÿ“ฆ Stirling-Tools / Stirling-Tools.github.io

๐Ÿ“„ README.md ยท 34 lines
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34# Stirling-PDF-Docs
Documentation for Stirling-PDF using [Docusaurus](https://docusaurus.io/)
Final version is hosted [here](https://docs.stirlingpdf.com/)

## Prerequisites

- [Node.js](https://nodejs.org/en/download) version 16.14 or above
- npm or yarn package manager

## Setup

1. Install dependencies:
```bash
npm install
```

2. Start the development server:
```bash
npm start
```

3. Edit files
   All our files are within the ``/docs`` directory, any edit made to the files here should instantly show on your local site

The site will be available at `http://localhost:3000`

## Contributing

Contributions are welcome! To add or update documentation:

1. Create or edit markdown files in the `docs/` directory
2. Preview changes locally using `npm start`
3. Submit a pull request