Skip to content

Commit

Permalink
refactor: update some broken links
Browse files Browse the repository at this point in the history
  • Loading branch information
sbplat committed Jan 6, 2024
1 parent 3ce3387 commit c3b0e50
Show file tree
Hide file tree
Showing 9 changed files with 111 additions and 121 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -14,5 +14,5 @@ To do this `ENDPOINTS_TO_REMOVE` and `GROUPS_TO_REMOVE` have been setup.
They can include comma-separated lists of endpoints and groups to disable. For example, `ENDPOINTS_TO_REMOVE=img-to-pdf,remove-pages` would disable both the "image to PDF" and "remove pages" functionalities.
`GROUPS_TO_REMOVE=Libre` Would disable a group of endpoints, in this case all endpoints which use Libre in the backend.

A complete list of all endpoints and groups is available [here](https://github.com/Frooodle/Stirling-PDF/blob/main/groups.md).
TODO?
A complete list of all endpoints and groups is available [here](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/Endpoint-groups.md).
TODO?
9 changes: 4 additions & 5 deletions docs/Contribute/Code.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
---
sidebar_position: 7
id: API
title: API
id: Code
title: Code
description: Create a doc page with rich content.
tags:
- API
- Code

---
# Stirling PDF API
Stirling PDF exposes a simple API for easy integration with external scripts. For an exhaustive list of all available API endpoints and their functions, please refer to our [API guide](https://github.com/Frooodle/Stirling-PDF/blob/main/API.md).
TODO
9 changes: 4 additions & 5 deletions docs/Contribute/Language.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
---
sidebar_position: 7
id: API
title: API
id: Language
title: Add a New Language
description: Create a doc page with rich content.
tags:
- API
- Language

---
# Stirling PDF API
Stirling PDF exposes a simple API for easy integration with external scripts. For an exhaustive list of all available API endpoints and their functions, please refer to our [API guide](https://github.com/Frooodle/Stirling-PDF/blob/main/API.md).
See [HowToAddNewLanguage](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/HowToAddNewLanguage.md)
2 changes: 1 addition & 1 deletion docs/Getting started/Installation/Docker/Docker Install.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ title: Installation Guide

# Docker Images for Stirling-PDF

The docker image for Stirling-PDF is available on Docker Hub at [frooodle/s-pdf](https://hub.docker.com/r/frooodle/s-pdf) or on Github at [s-pdf](https://github.com/frooodle/Stirling-PDF/pkgs/container/s-pdf).
The docker image for Stirling-PDF is available on Docker Hub at [frooodle/s-pdf](https://hub.docker.com/r/frooodle/s-pdf) or on Github at [s-pdf](https://github.com/Stirling-Tools/Stirling-PDF/pkgs/container/s-pdf).

Please note that Stirling PDF offers three distinct versions tailored for various hardware configurations. Users seeking optimal performance on lower-end hardware can choose from the specific versions provided. For those who prefer the most recent features and updates, it is recommended to continue using the latest tag.

Expand Down
4 changes: 2 additions & 2 deletions docs/Getting started/Installation/Local/Unix.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ pip3 install uno opencv-python-headless unoconv pngquant

```bash
cd ~/.git &&\
git clone https://github.com/Frooodle/Stirling-PDF.git &&\
git clone https://github.com/Stirling-Tools/Stirling-PDF.git &&\
cd Stirling-PDF &&\
chmod +x ./gradlew &&\
./gradlew build
Expand Down Expand Up @@ -199,4 +199,4 @@ You can do this in the terminal by using the `export` command or -D arguments to
export APP_HOME_NAME="Stirling PDF"
or
-DAPP_HOME_NAME="Stirling PDF"
```
```
2 changes: 1 addition & 1 deletion docs/Getting started/Installation/Local/Windows.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: Windows installation Guide
---
# Windows Installation Guide for Stirling PDF

Stirling PDF provides Windows compatibility through a downloadable .exe file, which can be obtained from [here](https://github.com/Frooodle/Stirling-PDF/releases/latest).
Stirling PDF provides Windows compatibility through a downloadable .exe file, which can be obtained from [here](https://github.com/Stirling-Tools/Stirling-PDF/releases/latest).
This is a streamlined version of the application, offering the same capabilities as the Stirling-PDF-Ultra-lite found in Docker, but in a compact 50MB executable!

Simply download and launch the .exe file to access the Stirling-PDF Web-UI. It is important to note that this application requires JAVA 17. If the application identifies that this version of JAVA isn't installed on your system, it will prompt a link to download the appropriate version.
Expand Down
2 changes: 1 addition & 1 deletion docs/Overview/What is Stirling-PDF.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
sidebar_position: 1
---

![](https://raw.githubusercontent.com/Frooodle/Stirling-PDF/main/docs/stirling.png)
![](https://raw.githubusercontent.com/Stirling-Tools/Stirling-PDF/main/docs/stirling.png)

# Introduction to Stirling PDF

Expand Down
196 changes: 94 additions & 102 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -6,113 +6,105 @@ const darkCodeTheme = require('prism-react-renderer/themes/dracula');

/** @type {import('@docusaurus/types').Config} */
const config = {
title: 'Stirling-PDF',
tagline: 'Your locally hosted one-stop-shop for all your PDF needs.',
favicon: 'img/favicon.ico',
title: 'Stirling-PDF',
tagline: 'Your locally hosted one-stop-shop for all your PDF needs.',
favicon: 'img/favicon.ico',

// Set the production url of your site here
url: 'https://your-stirling-pdf-site.com',
// Set the /<baseUrl>/ pathname under which your site is served
baseUrl: '/',
// Set the production url of your site here
url: 'https://stirlingtools.com',
// Set the /<baseUrl>/ pathname under which your site is served
baseUrl: '/',

organizationName: 'Frooodle', // Usually your GitHub org/user name.
projectName: 'Stirling-PDF', // Usually your repo name.
organizationName: 'Stirling-Tools', // Usually your GitHub org/user name.
projectName: 'Stirling-PDF', // Usually your repo name.

onBrokenLinks: 'throw',
onBrokenMarkdownLinks: 'warn',
onBrokenLinks: 'throw',
onBrokenMarkdownLinks: 'warn',

i18n: {
defaultLocale: 'en',
locales: ['en'],
},
i18n: {
defaultLocale: 'en',
locales: ['en'],
},

presets: [
[
'classic',
/** @type {import('@docusaurus/preset-classic').Options} */
({
docs: {
sidebarPath: require.resolve('./sidebars.js'),
editUrl: 'https://github.com/Frooodle/Stirling-PDF/tree/main/',
},
theme: {
customCss: require.resolve('./src/css/custom.css'),
},
}),
],
],
presets: [
[
'classic',
/** @type {import('@docusaurus/preset-classic').Options} */
({
docs: {
sidebarPath: require.resolve('./sidebars.js'),
editUrl: 'https://github.com/Stirling-Tools/Stirling-PDF/tree/main/',
},
theme: {
customCss: require.resolve('./src/css/custom.css'),
},
}),
],
],

themeConfig:
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
({
image: 'img/stirling-social-card.png',
navbar: {
title: 'Stirling-PDF',
logo: {
alt: 'Stirling-PDF Logo',
src: 'img/logo.svg',
},
items: [
{
type: 'docSidebar',
sidebarId: 'tutorialSidebar',
position: 'left',
label: 'Docs',
},
{to: '/about', label: 'About', position: 'left'},

{to: '/Demos', label: 'Demos', position: 'left'},
{to: '/Donate', label: 'Donate', position: 'left'},
{to: '/Contact', label: 'Contact', position: 'left'},
{
href: 'https://github.com/Frooodle/Stirling-PDF',
label: 'GitHub',
position: 'right',
},
],
},
footer: {
style: 'dark',
links: [
{
title: 'Docs',
items: [
{
label: 'Tutorial',
to: '/docs/Overview/What%20is%20Stirling-PDF',
},
],
},
{
title: 'Community',
items: [
{
label: 'Discord',
href: 'https://discord.gg/Cn8pWhQRxZ',
},
{
label: 'Docker',
href: 'https://hub.docker.com/r/frooodle/s-pdf',
},
],
},
{
title: 'More',
items: [
{
label: 'GitHub',
href: 'https://github.com/Frooodle/Stirling-PDF',
},
],
},
],
copyright: `Copyright © ${new Date().getFullYear()} Stirling-PDF, Inc. Built with Docusaurus.`,
},
prism: {
theme: lightCodeTheme,
darkTheme: darkCodeTheme,
},
}),
themeConfig:
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
({
image: 'img/stirling-social-card.png',
navbar: {
title: 'Stirling-PDF',
logo: {
alt: 'Stirling-PDF Logo',
src: 'img/logo.svg',
},
items: [{
type: 'docSidebar',
sidebarId: 'tutorialSidebar',
position: 'left',
label: 'Docs',
},
{ to: '/about', label: 'About', position: 'left' },
{ to: '/Demos', label: 'Demos', position: 'left' },
{ to: '/Donate', label: 'Donate', position: 'left' },
{ to: '/Contact', label: 'Contact', position: 'left' },
{
href: 'https://github.com/Stirling-Tools/Stirling-PDF',
label: 'GitHub',
position: 'right',
},
],
},
footer: {
style: 'dark',
links: [{
title: 'Docs',
items: [{
label: 'Tutorial',
to: '/docs/Overview/What%20is%20Stirling-PDF',
}, ],
},
{
title: 'Community',
items: [{
label: 'Discord',
href: 'https://discord.gg/Cn8pWhQRxZ',
},
{
label: 'Docker',
href: 'https://hub.docker.com/r/frooodle/s-pdf',
},
],
},
{
title: 'More',
items: [{
label: 'GitHub',
href: 'https://github.com/Stirling-Tools/Stirling-PDF',
}, ],
},
],
copyright: `Copyright © ${new Date().getFullYear()} Stirling-PDF, Inc. Built with Docusaurus.`,
},
prism: {
theme: lightCodeTheme,
darkTheme: darkCodeTheme,
},
}),
};

module.exports = config;
module.exports = config;
4 changes: 2 additions & 2 deletions src/pages/contact.js
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ export default function Contact() {
</a>

<a
href="https://github.com/Frooodle/Stirling-PDF/issues"
href="https://github.com/Stirling-Tools/Stirling-PDF/issues"
target="_blank"
rel="noopener noreferrer"
style={{ fontSize: '20px', textDecoration: 'underline', color: '#0366d6', cursor: 'pointer' }} // Enhanced GitHub link styling
Expand All @@ -36,7 +36,7 @@ export default function Contact() {
</a>

<a
href="https://github.com/Frooodle/Stirling-PDF/discussions"
href="https://github.com/Stirling-Tools/Stirling-PDF/discussions"
target="_blank"
rel="noopener noreferrer"
style={{ fontSize: '20px', textDecoration: 'underline', color: '#0366d6', cursor: 'pointer' }} // Enhanced GitHub link styling
Expand Down

0 comments on commit c3b0e50

Please sign in to comment.