Compare commits
No commits in common. "master" and "OFDLV1.9.11" have entirely different histories.
master
...
OFDLV1.9.1
@ -1,36 +0,0 @@
|
|||||||
name: Publish docs
|
|
||||||
|
|
||||||
on:
|
|
||||||
push:
|
|
||||||
tags:
|
|
||||||
- 'OFDLV*'
|
|
||||||
paths:
|
|
||||||
- 'docs/**'
|
|
||||||
- '.gitea/workflows/publish-docs.yml'
|
|
||||||
workflow_dispatch:
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
build-and-deploy:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
steps:
|
|
||||||
- name: Checkout code
|
|
||||||
uses: actions/checkout@v3
|
|
||||||
|
|
||||||
- name: Set up Python
|
|
||||||
uses: actions/setup-python@v4
|
|
||||||
with:
|
|
||||||
python-version: '3.10'
|
|
||||||
|
|
||||||
- name: Install MkDocs
|
|
||||||
run: |
|
|
||||||
pip install mkdocs-material
|
|
||||||
|
|
||||||
- name: Build site
|
|
||||||
run: |
|
|
||||||
mkdocs build --clean
|
|
||||||
|
|
||||||
- name: Deploy site
|
|
||||||
run: |
|
|
||||||
sudo rm -rf /var/www/mkdocs/*
|
|
||||||
sudo cp -r site/* /var/www/mkdocs/
|
|
||||||
sudo chown -R www-data:www-data /var/www/mkdocs/
|
|
5
.gitignore
vendored
@ -367,7 +367,4 @@ FodyWeavers.xsd
|
|||||||
/OF DL/device_private_key
|
/OF DL/device_private_key
|
||||||
|
|
||||||
# Allow node_modules inside custom actions
|
# Allow node_modules inside custom actions
|
||||||
!.gitea-actions/**/node_modules/
|
!.gitea-actions/**/node_modules/
|
||||||
|
|
||||||
# venv
|
|
||||||
venv/
|
|
@ -7,7 +7,7 @@ Scrape all the media from an OnlyFans account
|
|||||||
Join the discord [here](https://discord.com/invite/6bUW8EJ53j)
|
Join the discord [here](https://discord.com/invite/6bUW8EJ53j)
|
||||||
|
|
||||||
# Documentation
|
# Documentation
|
||||||
Please refer to https://docs.ofdl.tools/ for instructions on:
|
Please refer to https://sim0n00ps.github.io/OF-DL/ for instructions on:
|
||||||
- Requirements
|
- Requirements
|
||||||
- Installing the Program
|
- Installing the Program
|
||||||
- Running the Program
|
- Running the Program
|
||||||
|
2
docs/.gitignore
vendored
@ -18,5 +18,3 @@
|
|||||||
npm-debug.log*
|
npm-debug.log*
|
||||||
yarn-debug.log*
|
yarn-debug.log*
|
||||||
yarn-error.log*
|
yarn-error.log*
|
||||||
|
|
||||||
venv/
|
|
1
docs/.nvmrc
Normal file
@ -0,0 +1 @@
|
|||||||
|
20.16.0
|
41
docs/README.md
Normal file
@ -0,0 +1,41 @@
|
|||||||
|
# Website
|
||||||
|
|
||||||
|
This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
|
||||||
|
|
||||||
|
### Installation
|
||||||
|
|
||||||
|
```
|
||||||
|
$ yarn
|
||||||
|
```
|
||||||
|
|
||||||
|
### Local Development
|
||||||
|
|
||||||
|
```
|
||||||
|
$ 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
|
||||||
|
|
||||||
|
```
|
||||||
|
$ yarn build
|
||||||
|
```
|
||||||
|
|
||||||
|
This command generates static content into the `build` directory and can be served using any static contents hosting service.
|
||||||
|
|
||||||
|
### Deployment
|
||||||
|
|
||||||
|
Using SSH:
|
||||||
|
|
||||||
|
```
|
||||||
|
$ USE_SSH=true yarn deploy
|
||||||
|
```
|
||||||
|
|
||||||
|
Not using SSH:
|
||||||
|
|
||||||
|
```
|
||||||
|
$ 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.
|
3
docs/babel.config.js
Normal file
@ -0,0 +1,3 @@
|
|||||||
|
module.exports = {
|
||||||
|
presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
|
||||||
|
};
|
8
docs/docs/config/_category_.json
Normal file
@ -0,0 +1,8 @@
|
|||||||
|
{
|
||||||
|
"label": "Configuration",
|
||||||
|
"position": 2,
|
||||||
|
"link": {
|
||||||
|
"type": "generated-index",
|
||||||
|
"description": "Configuration options and information for OF-DL"
|
||||||
|
}
|
||||||
|
}
|
@ -10,14 +10,18 @@ OF DL allows you to log in to your OnlyFans account directly. This simplifies th
|
|||||||
When prompted by the application, log into your OnlyFans account. Do not close the opened window, tab, or navigate away to another webpage.
|
When prompted by the application, log into your OnlyFans account. Do not close the opened window, tab, or navigate away to another webpage.
|
||||||
The new window will close automatically when the authentication process has finished.
|
The new window will close automatically when the authentication process has finished.
|
||||||
|
|
||||||
!!! warning
|
:::warning
|
||||||
|
|
||||||
Some users have reported that "Sign in with Google" has not been working with this authentication method.
|
Some users have reported that "Sign in with Google" has not been working with this authentication method.
|
||||||
If you use the Google sign-in option to log into your OnlyFans account, use one of the [legacy authentication methods](#legacy-methods) described below.
|
If you use the Google sign-in option to log into your OnlyFans account, use one of the [legacy authentication methods](#legacy-methods) described below.
|
||||||
|
|
||||||
!!! info
|
:::
|
||||||
|
|
||||||
If you are using docker, follow the special [authentication instructions documented](/installation/docker) to authenticate OF-DL
|
:::info
|
||||||
|
|
||||||
|
If you are using docker, follow the special [authentication instructions documented](/docs/installation/docker) to authenticate OF-DL
|
||||||
|
|
||||||
|
:::
|
||||||
|
|
||||||
## Legacy Methods
|
## Legacy Methods
|
||||||
|
|
@ -265,7 +265,7 @@ Default: `""`
|
|||||||
|
|
||||||
Allowed values: Any valid string
|
Allowed values: Any valid string
|
||||||
|
|
||||||
Description: Please refer to [custom filename formats](/config/custom-filename-formats#paidpostfilenameformat) page to see what fields you can use.
|
Description: Please refer to [custom filename formats](/docs/config/custom-filename-formats#paidpostfilenameformat) page to see what fields you can use.
|
||||||
|
|
||||||
## PostFileNameFormat
|
## PostFileNameFormat
|
||||||
|
|
||||||
@ -275,7 +275,7 @@ Default: `""`
|
|||||||
|
|
||||||
Allowed values: Any valid string
|
Allowed values: Any valid string
|
||||||
|
|
||||||
Description: Please refer to the [custom filename formats](/config/custom-filename-formats#postfilenameformat) page to see what fields you can use.
|
Description: Please refer to the [custom filename formats](/docs/config/custom-filename-formats#postfilenameformat) page to see what fields you can use.
|
||||||
|
|
||||||
## PaidMessageFileNameFormat
|
## PaidMessageFileNameFormat
|
||||||
|
|
||||||
@ -285,7 +285,7 @@ Default: `""`
|
|||||||
|
|
||||||
Allowed values: Any valid string
|
Allowed values: Any valid string
|
||||||
|
|
||||||
Description: Please refer to [custom filename formats](/config/custom-filename-formats#paidmessagefilenameformat) page to see what fields you can use.
|
Description: Please refer to [custom filename formats](/docs/config/custom-filename-formats#paidmessagefilenameformat) page to see what fields you can use.
|
||||||
|
|
||||||
## MessageFileNameFormat
|
## MessageFileNameFormat
|
||||||
|
|
||||||
@ -295,7 +295,7 @@ Default: `""`
|
|||||||
|
|
||||||
Allowed values: Any valid string
|
Allowed values: Any valid string
|
||||||
|
|
||||||
Description: Please refer to [custom filename formats](/config/custom-filename-formats#messagefilenameformat) page to see what fields you can use.
|
Description: Please refer to [custom filename formats](/docs/config/custom-filename-formats#messagefilenameformat) page to see what fields you can use.
|
||||||
|
|
||||||
## RenameExistingFilesWhenCustomFormatIsSelected
|
## RenameExistingFilesWhenCustomFormatIsSelected
|
||||||
|
|
||||||
@ -322,7 +322,7 @@ Description: This configuration options allows you to set file name formats for
|
|||||||
This is useful if you want to have different file name formats for different creators. The values set here will override the global values set in the config file
|
This is useful if you want to have different file name formats for different creators. The values set here will override the global values set in the config file
|
||||||
(see [PaidPostFileNameFormat](#paidpostfilenameformat), [PostFileNameFormat](#postfilenameformat),
|
(see [PaidPostFileNameFormat](#paidpostfilenameformat), [PostFileNameFormat](#postfilenameformat),
|
||||||
[PaidMessageFileNAmeFormat](#paidmessagefilenameformat), and [MessageFileNameFormat](#messagefilenameformat)).
|
[PaidMessageFileNAmeFormat](#paidmessagefilenameformat), and [MessageFileNameFormat](#messagefilenameformat)).
|
||||||
For more information on the file name formats, see the [custom filename formats](/config/custom-filename-formats) page.
|
For more information on the file name formats, see the [custom filename formats](/docs/config/custom-filename-formats) page.
|
||||||
|
|
||||||
Example:
|
Example:
|
||||||
```
|
```
|
||||||
@ -435,13 +435,15 @@ Description: If set to `true`, the program will run without any input from the u
|
|||||||
(unless [NonInteractiveModeListName](#noninteractivemodelistname) or [NonInteractiveModePurchasedTab](#noninteractivemodepurchasedtab) are configured).
|
(unless [NonInteractiveModeListName](#noninteractivemodelistname) or [NonInteractiveModePurchasedTab](#noninteractivemodepurchasedtab) are configured).
|
||||||
If set to `false`, the default behaviour will apply, and you will be able to choose an option from the menu.
|
If set to `false`, the default behaviour will apply, and you will be able to choose an option from the menu.
|
||||||
|
|
||||||
!!! warning
|
:::warning
|
||||||
|
|
||||||
If NonInteractiveMode is enabled, you will be unable to authenticate OF-DL using the standard authentication method.
|
If NonInteractiveMode is enabled, you will be unable to authenticate OF-DL using the standard authentication method.
|
||||||
Before you can run OF-DL in NonInteractiveMode, you must either
|
Before you can run OF-DL in NonInteractiveMode, you must either
|
||||||
|
|
||||||
1. Generate an auth.json file by running OF-DL with NonInteractiveMode disabled and authenticating OF-DL using the standard method **OR**
|
1. Generate an auth.json file by running OF-DL with NonInteractiveMode disabled and authenticating OF-DL using the standard method **OR**
|
||||||
2. Generate an auth.json file by using a [legacy authentication method](/config/auth#legacy-methods)
|
2. Generate an auth.json file by using a [legacy authentication method](/docs/config/auth#legacy-methods)
|
||||||
|
|
||||||
|
:::
|
||||||
|
|
||||||
## NonInteractiveModeListName
|
## NonInteractiveModeListName
|
||||||
|
|
8
docs/docs/installation/_category_.json
Normal file
@ -0,0 +1,8 @@
|
|||||||
|
{
|
||||||
|
"label": "Installation",
|
||||||
|
"position": 1,
|
||||||
|
"link": {
|
||||||
|
"type": "generated-index",
|
||||||
|
"description": "Installation instructions for OF-DL"
|
||||||
|
}
|
||||||
|
}
|
@ -5,7 +5,7 @@ sidebar_position: 3
|
|||||||
# Linux
|
# Linux
|
||||||
|
|
||||||
A Linux release of OF-DL is not available at this time, however you can run OF-DL on Linux using Docker.
|
A Linux release of OF-DL is not available at this time, however you can run OF-DL on Linux using Docker.
|
||||||
Please refer to the [Docker](/installation/docker) page for instructions on how to run OF-DL in a Docker container.
|
Please refer to the [Docker](/docs/installation/docker) page for instructions on how to run OF-DL in a Docker container.
|
||||||
If you do not have Docker installed, you can download it from [here](https://docs.docker.com/desktop/install/linux-install/).
|
If you do not have Docker installed, you can download it from [here](https://docs.docker.com/desktop/install/linux-install/).
|
||||||
If you would like to run OF-DL natively on Linux, you can build it from source by following the instructions below.
|
If you would like to run OF-DL natively on Linux, you can build it from source by following the instructions below.
|
||||||
|
|
@ -5,5 +5,5 @@ sidebar_position: 4
|
|||||||
# macOS
|
# macOS
|
||||||
|
|
||||||
macOS releases of OF-DL are not available at this time, however you can run OF-DL on macOS using Docker.
|
macOS releases of OF-DL are not available at this time, however you can run OF-DL on macOS using Docker.
|
||||||
Please refer to the [Docker](/installation/docker) page for instructions on how to run OF-DL in a Docker container.
|
Please refer to the [Docker](/docs/installation/docker) page for instructions on how to run OF-DL in a Docker container.
|
||||||
If you do not have Docker installed, you can download it from [here](https://docs.docker.com/desktop/install/mac-install/).
|
If you do not have Docker installed, you can download it from [here](https://docs.docker.com/desktop/install/mac-install/).
|
@ -11,7 +11,7 @@ sidebar_position: 1
|
|||||||
You will need to download FFmpeg. You can download it from [here](https://www.gyan.dev/ffmpeg/builds/).
|
You will need to download FFmpeg. You can download it from [here](https://www.gyan.dev/ffmpeg/builds/).
|
||||||
Make sure you download `ffmpeg-release-essentials.zip`. Unzip it anywhere on your computer. You only need `ffmpeg.exe`, and you can ignore the rest.
|
Make sure you download `ffmpeg-release-essentials.zip`. Unzip it anywhere on your computer. You only need `ffmpeg.exe`, and you can ignore the rest.
|
||||||
Move `ffmpeg.exe` to the same folder as `OF DL.exe` (downloaded in the installation steps below). If you choose to move `ffmpeg.exe` to a different folder,
|
Move `ffmpeg.exe` to the same folder as `OF DL.exe` (downloaded in the installation steps below). If you choose to move `ffmpeg.exe` to a different folder,
|
||||||
you will need to specify the path to `ffmpeg.exe` in the config file (see the `FFmpegPath` [config option](/config/configuration#ffmpegpath)).
|
you will need to specify the path to `ffmpeg.exe` in the config file (see the `FFmpegPath` [config option](/docs/config/configuration#ffmpegpath)).
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
@ -4,7 +4,7 @@ sidebar_position: 3
|
|||||||
|
|
||||||
# Running the Program
|
# Running the Program
|
||||||
|
|
||||||
Once you are happy you have filled everything in [auth.json](/config/auth) correctly, you can double click OF-DL.exe and you should see a command prompt window appear, it should look something like this:
|
Once you are happy you have filled everything in [auth.json](/docs/config/auth) correctly, you can double click OF-DL.exe and you should see a command prompt window appear, it should look something like this:
|
||||||
|
|
||||||

|

|
||||||
|
|
123
docs/docusaurus.config.js
Normal file
@ -0,0 +1,123 @@
|
|||||||
|
// @ts-check
|
||||||
|
// `@type` JSDoc annotations allow editor autocompletion and type checking
|
||||||
|
// (when paired with `@ts-check`).
|
||||||
|
// There are various equivalent ways to declare your Docusaurus config.
|
||||||
|
// See: https://docusaurus.io/docs/api/docusaurus-config
|
||||||
|
|
||||||
|
import {themes as prismThemes} from 'prism-react-renderer';
|
||||||
|
|
||||||
|
/** @type {import('@docusaurus/types').Config} */
|
||||||
|
const config = {
|
||||||
|
title: 'OF-DL',
|
||||||
|
tagline: 'A media scraper for OnlyFans with DRM video support',
|
||||||
|
favicon: 'img/logo.png',
|
||||||
|
|
||||||
|
// Set the production url of your site here
|
||||||
|
url: 'https://sim0n00ps.github.io',
|
||||||
|
// Set the /<baseUrl>/ pathname under which your site is served
|
||||||
|
// For GitHub pages deployment, it is often '/<projectName>/'
|
||||||
|
baseUrl: '/OF-DL/',
|
||||||
|
|
||||||
|
// GitHub pages deployment config.
|
||||||
|
// If you aren't using GitHub pages, you don't need these.
|
||||||
|
organizationName: 'sim0n00ps', // Usually your GitHub org/user name.
|
||||||
|
projectName: 'OF-DL', // Usually your repo name.
|
||||||
|
|
||||||
|
onBrokenLinks: 'throw',
|
||||||
|
onBrokenMarkdownLinks: 'warn',
|
||||||
|
|
||||||
|
// Even if you don't use internationalization, you can use this field to set
|
||||||
|
// useful metadata like html lang. For example, if your site is Chinese, you
|
||||||
|
// may want to replace "en" with "zh-Hans".
|
||||||
|
i18n: {
|
||||||
|
defaultLocale: 'en',
|
||||||
|
locales: ['en'],
|
||||||
|
},
|
||||||
|
|
||||||
|
presets: [
|
||||||
|
[
|
||||||
|
'@docusaurus/preset-classic',
|
||||||
|
/** @type {import('@docusaurus/preset-classic').Options} */
|
||||||
|
({
|
||||||
|
docs: {
|
||||||
|
sidebarPath: './sidebars.js',
|
||||||
|
},
|
||||||
|
blog: false,
|
||||||
|
}),
|
||||||
|
],
|
||||||
|
],
|
||||||
|
|
||||||
|
themeConfig:
|
||||||
|
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
|
||||||
|
({
|
||||||
|
colorMode: {
|
||||||
|
respectPrefersColorScheme: true,
|
||||||
|
},
|
||||||
|
navbar: {
|
||||||
|
title: 'OF-DL',
|
||||||
|
logo: {
|
||||||
|
alt: 'OF-DL Logo',
|
||||||
|
src: 'img/logo.png',
|
||||||
|
},
|
||||||
|
items: [
|
||||||
|
{
|
||||||
|
type: 'docSidebar',
|
||||||
|
sidebarId: 'generatedSidebar',
|
||||||
|
position: 'left',
|
||||||
|
label: 'Docs',
|
||||||
|
},
|
||||||
|
{
|
||||||
|
href: 'https://github.com/sim0n00ps/OF-DL',
|
||||||
|
label: 'GitHub',
|
||||||
|
position: 'right',
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
footer: {
|
||||||
|
style: 'dark',
|
||||||
|
links: [
|
||||||
|
{
|
||||||
|
title: 'Docs',
|
||||||
|
items: [
|
||||||
|
{
|
||||||
|
label: 'Installation',
|
||||||
|
to: '/docs/installation/windows',
|
||||||
|
},
|
||||||
|
{
|
||||||
|
label: 'Configuration',
|
||||||
|
to: '/docs/config/auth',
|
||||||
|
},
|
||||||
|
{
|
||||||
|
label: 'Running the Program',
|
||||||
|
to: '/docs/running-the-program',
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
{
|
||||||
|
title: 'Community',
|
||||||
|
items: [
|
||||||
|
{
|
||||||
|
label: 'Discord',
|
||||||
|
href: 'https://discord.com/invite/6bUW8EJ53j',
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
{
|
||||||
|
title: 'More',
|
||||||
|
items: [
|
||||||
|
{
|
||||||
|
label: 'GitHub',
|
||||||
|
href: 'https://github.com/sim0n00ps/OF-DL',
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
prism: {
|
||||||
|
theme: prismThemes.github,
|
||||||
|
darkTheme: prismThemes.dracula,
|
||||||
|
},
|
||||||
|
}),
|
||||||
|
};
|
||||||
|
|
||||||
|
export default config;
|
Before Width: | Height: | Size: 109 KiB |
@ -1,8 +0,0 @@
|
|||||||
# Welcome to OF-DL
|
|
||||||
|
|
||||||
C# console app to download all of the media from Onlyfans accounts with DRM video downloading support.
|
|
||||||
|
|
||||||
!!! info "PLEASE READ BEFORE DOWNLOADING"
|
|
||||||
THIS TOOL CANNOT BYPASS PAYWALLS, IT CAN ONLY DOWNLOAD CONTENT YOU HAVE ACCESS TO, PLEASE DO NOT DOWNLOAD THIS TOOL THINKING YOU CAN BYPASS PAYING FOR THINGS!!!!!
|
|
||||||
|
|
||||||
Join the discord [here](https://discord.com/invite/6bUW8EJ53j)
|
|
15550
docs/package-lock.json
generated
Normal file
44
docs/package.json
Normal file
@ -0,0 +1,44 @@
|
|||||||
|
{
|
||||||
|
"name": "of-dl",
|
||||||
|
"version": "0.0.0",
|
||||||
|
"private": true,
|
||||||
|
"scripts": {
|
||||||
|
"docusaurus": "docusaurus",
|
||||||
|
"start": "docusaurus start",
|
||||||
|
"build": "docusaurus build",
|
||||||
|
"swizzle": "docusaurus swizzle",
|
||||||
|
"deploy": "docusaurus deploy",
|
||||||
|
"clear": "docusaurus clear",
|
||||||
|
"serve": "docusaurus serve",
|
||||||
|
"write-translations": "docusaurus write-translations",
|
||||||
|
"write-heading-ids": "docusaurus write-heading-ids"
|
||||||
|
},
|
||||||
|
"dependencies": {
|
||||||
|
"@docusaurus/core": "3.4.0",
|
||||||
|
"@docusaurus/preset-classic": "3.4.0",
|
||||||
|
"@mdx-js/react": "^3.0.0",
|
||||||
|
"clsx": "^2.0.0",
|
||||||
|
"prism-react-renderer": "^2.3.0",
|
||||||
|
"react": "^18.0.0",
|
||||||
|
"react-dom": "^18.0.0"
|
||||||
|
},
|
||||||
|
"devDependencies": {
|
||||||
|
"@docusaurus/module-type-aliases": "3.4.0",
|
||||||
|
"@docusaurus/types": "3.4.0"
|
||||||
|
},
|
||||||
|
"browserslist": {
|
||||||
|
"production": [
|
||||||
|
">0.5%",
|
||||||
|
"not dead",
|
||||||
|
"not op_mini all"
|
||||||
|
],
|
||||||
|
"development": [
|
||||||
|
"last 3 chrome version",
|
||||||
|
"last 3 firefox version",
|
||||||
|
"last 5 safari version"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
"engines": {
|
||||||
|
"node": ">=18.0"
|
||||||
|
}
|
||||||
|
}
|
33
docs/sidebars.js
Normal file
@ -0,0 +1,33 @@
|
|||||||
|
/**
|
||||||
|
* Creating a sidebar enables you to:
|
||||||
|
- create an ordered group of docs
|
||||||
|
- render a sidebar for each doc of that group
|
||||||
|
- provide next/previous navigation
|
||||||
|
|
||||||
|
The sidebars can be generated from the filesystem, or explicitly defined here.
|
||||||
|
|
||||||
|
Create as many sidebars as you want.
|
||||||
|
*/
|
||||||
|
|
||||||
|
// @ts-check
|
||||||
|
|
||||||
|
/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
|
||||||
|
const sidebars = {
|
||||||
|
// By default, Docusaurus generates a sidebar from the docs folder structure
|
||||||
|
generatedSidebar: [{type: 'autogenerated', dirName: '.'}],
|
||||||
|
|
||||||
|
// But you can create a sidebar manually
|
||||||
|
/*
|
||||||
|
tutorialSidebar: [
|
||||||
|
'intro',
|
||||||
|
'hello',
|
||||||
|
{
|
||||||
|
type: 'category',
|
||||||
|
label: 'Tutorial',
|
||||||
|
items: ['tutorial-basics/create-a-document'],
|
||||||
|
},
|
||||||
|
],
|
||||||
|
*/
|
||||||
|
};
|
||||||
|
|
||||||
|
export default sidebars;
|
39
docs/src/pages/index.js
Normal file
@ -0,0 +1,39 @@
|
|||||||
|
import clsx from 'clsx';
|
||||||
|
import Link from '@docusaurus/Link';
|
||||||
|
import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
|
||||||
|
import Layout from '@theme/Layout';
|
||||||
|
|
||||||
|
import Heading from '@theme/Heading';
|
||||||
|
import styles from './index.module.css';
|
||||||
|
|
||||||
|
function HomepageHeader() {
|
||||||
|
const {siteConfig} = useDocusaurusContext();
|
||||||
|
return (
|
||||||
|
<header className={clsx('hero hero--primary', styles.heroBanner)}>
|
||||||
|
<div className="container">
|
||||||
|
<Heading as="h1" className="hero__title">
|
||||||
|
{siteConfig.title}
|
||||||
|
</Heading>
|
||||||
|
<p className="hero__subtitle">{siteConfig.tagline}</p>
|
||||||
|
<div className={styles.buttons}>
|
||||||
|
<Link
|
||||||
|
className="button button--secondary button--lg"
|
||||||
|
to="docs/installation/windows">
|
||||||
|
Installation
|
||||||
|
</Link>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</header>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
export default function Home() {
|
||||||
|
const {siteConfig} = useDocusaurusContext();
|
||||||
|
return (
|
||||||
|
<Layout
|
||||||
|
title={siteConfig.title}
|
||||||
|
description={siteConfig.tagline}>
|
||||||
|
<HomepageHeader />
|
||||||
|
</Layout>
|
||||||
|
);
|
||||||
|
}
|
23
docs/src/pages/index.module.css
Normal file
@ -0,0 +1,23 @@
|
|||||||
|
/**
|
||||||
|
* CSS files with the .module.css suffix will be treated as CSS modules
|
||||||
|
* and scoped locally.
|
||||||
|
*/
|
||||||
|
|
||||||
|
.heroBanner {
|
||||||
|
padding: 4rem 0;
|
||||||
|
text-align: center;
|
||||||
|
position: relative;
|
||||||
|
overflow: hidden;
|
||||||
|
}
|
||||||
|
|
||||||
|
@media screen and (max-width: 996px) {
|
||||||
|
.heroBanner {
|
||||||
|
padding: 2rem;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
.buttons {
|
||||||
|
display: flex;
|
||||||
|
align-items: center;
|
||||||
|
justify-content: center;
|
||||||
|
}
|
0
docs/static/.nojekyll
vendored
Normal file
Before Width: | Height: | Size: 22 KiB After Width: | Height: | Size: 22 KiB |
BIN
docs/static/img/logo.png
vendored
Normal file
After Width: | Height: | Size: 769 B |
Before Width: | Height: | Size: 18 KiB After Width: | Height: | Size: 18 KiB |
Before Width: | Height: | Size: 59 KiB After Width: | Height: | Size: 59 KiB |
Before Width: | Height: | Size: 1.7 KiB After Width: | Height: | Size: 1.7 KiB |
46
mkdocs.yml
@ -1,46 +0,0 @@
|
|||||||
site_name: OF-DL Docs
|
|
||||||
site_url: https://docs.ofdl.tools
|
|
||||||
theme:
|
|
||||||
name: material
|
|
||||||
features:
|
|
||||||
- navigation.tabs
|
|
||||||
- navigation.top
|
|
||||||
- navigation.instant
|
|
||||||
- navigation.expand
|
|
||||||
- navigation.sections
|
|
||||||
- navigation.tracking
|
|
||||||
- navigation.search.highlight
|
|
||||||
- navigation.search.suggest
|
|
||||||
- navigation.search.share
|
|
||||||
- navigation.search.suggest
|
|
||||||
- navigation.search.share
|
|
||||||
- navigation.search.suggest
|
|
||||||
- navigation.search.share
|
|
||||||
language: en
|
|
||||||
palette:
|
|
||||||
- scheme: default
|
|
||||||
toggle:
|
|
||||||
icon: material/toggle-switch-off-outline
|
|
||||||
name: Switch to dark mode
|
|
||||||
primary: dark-blue
|
|
||||||
accent: white
|
|
||||||
- scheme: slate
|
|
||||||
toggle:
|
|
||||||
icon: material/toggle-switch
|
|
||||||
name: Switch to light mode
|
|
||||||
primary: dark-blue
|
|
||||||
accent: white
|
|
||||||
font:
|
|
||||||
text: Roboto
|
|
||||||
code: Roboto Mono
|
|
||||||
logo: img/logo.ico
|
|
||||||
favicon: img/logo.ico
|
|
||||||
markdown_extensions:
|
|
||||||
- admonition
|
|
||||||
- pymdownx.details
|
|
||||||
- pymdownx.superfences
|
|
||||||
extra:
|
|
||||||
social:
|
|
||||||
- icon: fontawesome/brands/discord
|
|
||||||
link: https://discord.com/invite/6bUW8EJ53j
|
|
||||||
copyright: "© 2025 OF-DL. All rights reserved."
|
|