-
Notifications
You must be signed in to change notification settings - Fork 17
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
28 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |