Skip to content

Commit

Permalink
added templates for the doumentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
feahnthor committed Oct 17, 2023
1 parent a11162f commit abce1c3
Show file tree
Hide file tree
Showing 15 changed files with 100 additions and 20 deletions.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified .vs/feahnthor.github.io/v17/.wsuo
Binary file not shown.
Binary file modified .vs/slnx.sqlite
Binary file not shown.
6 changes: 3 additions & 3 deletions _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@ title: Feahnthor
email: test@gmail.com
description: A collection of projects by Henry F.
baseurl: ""
url: "https://feahnthor.github.io"
github:
url: https://feahnthor.github.io
zip_url: http://example.com/download.zip
another_url: another value
show_downloads: ["true"]
show_downloads: true
remote_theme: pages-themes/cayman@v0.2.0
plugins:
- jekyll-remote-theme # add this line to the plugins list if you already have one
- jekyll-remote-theme

18 changes: 18 additions & 0 deletions _docs/Benny-Scraper/adding-new-stites.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
layout: default
title: Adding New Sites to Benny-Scraper
---

# Adding New Sites to Benny-Scraper

Guidelines and steps on how to integrate and add new sites to the scraper.

## Step 1: Identify the Site

Description of the first step...

## Step 2: Configure the Scraper

Description of the second step...

... (and so on for each step)
14 changes: 14 additions & 0 deletions _docs/Benny-Scraper/benny-scraper.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
layout: default
title: Benny-Scraper Detailed Documentation
---

# Benny-Scraper Detailed Documentation

Benny-Scraper is a versatile tool built in C# designed to store Webnovels as Epubs and mangas as either PDFs or Comicbook Archives. This page serves as an entry point to the detailed documentation of its components.

## Table of Contents

- [Methods](methods.md)
- [Classes](classes.md)
- [Adding New Sites](adding-new-sites.md)
18 changes: 18 additions & 0 deletions _docs/Benny-Scraper/classes.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
layout: default
title: Benny-Scraper Classes
---

# Benny-Scraper Classes

In-depth documentation of the classes within Benny-Scraper.

## Class 1

Description and properties of Class 1...

## Class 2

Description and properties of Class 2...

... (and so on for each class)
18 changes: 18 additions & 0 deletions _docs/Benny-Scraper/methods.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
layout: default
title: Benny-Scraper Methods
---

# Benny-Scraper Methods

Detailed documentation of the methods used in Benny-Scraper.

## Method 1

Description and usage of Method 1...

## Method 2

Description and usage of Method 2...

... (and so on for each method)
33 changes: 29 additions & 4 deletions index.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,35 @@
---
layout: default
title: Home
title: Benny-Scraper Documentation
---

# Welcome to my projects page! Here are some of the projects I've worked on:
# Benny-Scraper Documentation

## - [Benny-Scraper](./projects/benny-scraper.md)
Welcome to the official documentation for Benny-Scraper, a web scraper designed to store Webnovels as Epubs and mangas as either PDFs or Comicbook Archives. This documentation provides in-depth details on its methods, classes, and guidelines on adding new sites.

More to come soon!
## Table of Contents

- [Overview](benny-scraper.md)
- [Methods](benny-scraper/methods.md)
- [Classes](benny-scraper/classes.md)
- [Adding New Sites](benny-scraper/adding-new-sites.md)
- [Other Projects](#other-projects)
- [Contribution](#contribution)

## Overview

Benny-Scraper is a versatile tool built in C# that allows users to store all chapters of their favorite Mangas or Webnovels offline in one file, primarily as Epubs.

## Other Projects

For documentation on our other projects, please visit the respective links below:

- [Project Name 1](/-docs/project-name-1/documentation.md)
- [Project Name 2](/-docs/project-name-2/documentation.md)
- ... (Add more as needed)

## Contribution

We're always open to contributions. If you're interested in enhancing Benny-Scraper's features, fixing bugs, or adding new sites, please refer to the contribution section in the README.

[Contribution Guidelines](/docs/contribution.md)
13 changes: 0 additions & 13 deletions projects/benny-scraper.md

This file was deleted.

0 comments on commit abce1c3

Please sign in to comment.