Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Frooodle authored Jan 6, 2025
1 parent 7b40d64 commit 9e5c573
Showing 1 changed file with 28 additions and 2 deletions.
30 changes: 28 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,30 @@
# Stirling-PDF-Docs
Documentation for Stirling-PDF using docusarus
Documentation for Stirling-PDF using [Docusaurus](https://docusaurus.io/)
Final version is hosted [here](https://docs.stirlingpdf.com/)

Users are welcome to request or update documentation
## 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
```

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

0 comments on commit 9e5c573

Please sign in to comment.