Developers
The Following Steps are for if you want to edit the Documentation Files:
1. Clone the Repository's Documentation branch:
git clone -b docs https://github.com/RyanBaig/TerminalTools.git
2. Navigate to the Repository Folder:
cd TerminalTools
3. Install Dependencies:
pip install -r requirements.txt
4. Launch Development Server:
mkdocs serve
5. Documentation Files Structure:
The documentation files are structured as follows:
docs/
│
├── index.md (The Main Page)
│
├── assets/
│ ├── icon.svg (For Icon in Documentation)
│ ├── icon.ico (For Icon in Installation Window)
│
├── modules/ (Section)
│ ├── file-management/ (Subsection)
│ ├── copy-file-directory.md
│ ├── create-directory.md
│ ├── delete-file-directory.md
│ ├── index.md (The Main Overview Page of File Management Module)
│ ├── list-files-directories.md
│ ├── move-file-directory.md
│ ├── rename-file-directory.md
│ ├── search-files-directory.md
│
│ ├── db-management/ (Subsection)
│ ├── create-database.md
│ ├── create-table.md
│ ├── display-database.md
│ ├── index.md (The Main Overview Page of Database Management Module)
│ ├── sql-query.md
│
│ ├── web-scraping/ (Subsection)
│ ├── fetch-html-content.md
│ ├── index.md (The Main Overview Page of Web Scraping Module)
│ ├── parse-html-from-elements-and-attributes.md
│ ├── take-screenshot-of-website.md
│
│ ├── miscellaneous/ (Subsection)
│ ├── coder-search.md
│ ├── dev-server.md
│ ├── exe.md
│ ├── index.md (The Main Overview Page of Miscellaneous Module)
The Following Steps are for if you want to edit the main Tool's Files:
1. Clone the Repository:
git clone https://github.com/RyanBaig/TerminalTools.git
2. Navigate to the Repository Folder:
cd TerminalTools
3. Contribute Your Share:
If you'd like to contribute by adding features or other improvements, submit a pull request.