๐ŸŒ AIๆœ็ดข & ไปฃ็† ไธป้กต
Skip to content
/ ContentSee Public template

A simple, customizable website template to showcase (images, PDFs, audios, videos, and links). Built for non-technical users: configure everything in google sheets files and upload your media - no coding required.

License

Notifications You must be signed in to change notification settings

NaelAqel/ContentSee

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

7 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

๐Ÿ“‚ ContentSee Template

A simple, customizable website template to showcase images, PDFs, audios, videos, and links.
Built for non-technical users: configure everything in google sheets files and upload your media - no coding required.

๐Ÿ‘‰ Full User Guide


๐Ÿš€ Quick Start

  1. Use Template in your Won Page

    • Click Use this template at the top of this repository.
    • Name the new repository {your-username}.github.io, and make sure it is Public
  2. Prepare Media:

    • Put all your media files in a folder.
  3. Get the template files

  4. Generate thumbnails

    • Open generate_thumbnails.ipynb in Google Colab.
    • Follow the notebook instructions to process your media and create thumbnails.
    • Download the generated media.zip and unzip it.
    • Copy the generated filenames for reference to fill in data.
  5. Fill sheets

    • Fill config with your site name, description, banner, contacts, and language.
    • Fill tags with categories/tags for your media.
    • Open data and fill the filenames you copied to file_name column.
    • Copy the tags link to import_tags sheet
    • Fill data with media titles, tags, links, etc.
  6. Download and replace

    • Download all files (config.csv, tags.csv, data.csv) from Google Drive.
    • Place them in the media/ folder.
  7. Test locally

    • Run a local web server to preview your site (required for JavaScript to work correctly).

    Step 1: Install Python (if not already installed)

    • Windows:
      1. Open Command Prompt and check Python:
        python --version
      2. If not installed, download and install from python.org or install via winget:
        winget install Python.Python.3
    • Linux:
      • Install via package manager:
        # Debian/Ubuntu
        sudo apt update
        sudo apt install python3
        # Fedora/RedHat
        sudo dnf install python3
    • Mac:
      • Python 3 is usually pre-installed.
      • If not, install via Homebrew:
        brew install python

    Step 2: Run the local server

    1. Open terminal / command prompt.
    2. Navigate to the folder containing index.html.
    3. Run the server:
      # Python 3.x
      python -m http.server 8000
      # or, if needed
      python3 -m http.server 8000
    4. Open your browser and go to: http://localhost:8000
    5. Verify that thumbnails, banner, description, and contacts display correctly.
  8. Push to GitHub

    • Only upload the full media folder to the repo.

Full step-by-step instructions with screenshots and troubleshooting tips are in GUIDE.pdf.


โœจ Features

  • Free for personal use.
  • Configurable.
  • Auto-thumbnails:
    • PDFs โ†’ first page โ†’ .png
    • Videos โ†’ 1-second frame โ†’ .png
    • Images โ†’ used directly
  • SEO ready (<title>, <meta description>, JSON-LD).
  • Client-side only; no backend required for the website itself.
  • Works locally via a simple local server (Python recommended) or hosted anywhere.

๐Ÿ“ Repo Structure


assets/                       โ†’ Template assets (do not modify unless you know what youโ€™re doing)
โ”œโ”€โ”€ css/
โ”‚ โ”œโ”€โ”€ base.css                โ†’ Basic styling for the template
โ”‚ โ”œโ”€โ”€ filters.css             โ†’ Styles for media filtering UI
โ”‚ โ”œโ”€โ”€ gallery.css             โ†’ Styles for gallery layout
โ”‚ โ””โ”€โ”€ theme.css               โ†’ Theme and color customization
โ”œโ”€โ”€ js/
โ”‚ โ”œโ”€โ”€ constants.js            โ†’ Constant values used in the template
โ”‚ โ”œโ”€โ”€ dataloader.js           โ†’ Loads data from media
โ”‚ โ”œโ”€โ”€ filter.js               โ†’ Handles filtering functionality
โ”‚ โ”œโ”€โ”€ initializers.js         โ†’ Handles page initialization
โ”‚ โ”œโ”€โ”€ main.js                 โ†’ Main script to initialize the site
โ”‚ โ”œโ”€โ”€ renderer.js             โ†’ Handles rendering of media items
โ”‚ โ”œโ”€โ”€ seo.js                  โ†’ SEO-related functions
โ”‚ โ””โ”€โ”€ utils.js                โ†’ Utility functions
โ””โ”€โ”€ generic-icon.svg          โ†’ Default icon used for PDFs/videos

โ”œโ”€โ”€ media/                    โ†’ All your work will be here
โ”‚ โ”œโ”€โ”€ thumbnails/ {files}     โ†’ Thumbnails photos for PDFs ans videos
โ”‚ โ”œโ”€โ”€ data.csv                โ†’ Media list with titles, tags, links
โ”‚ โ”œโ”€โ”€ config.csv              โ†’ Site settings (site name, banner, contacts, etc.)
โ”‚ โ”œโ”€โ”€ tags.csv                โ†’ Categories/tags for your media
โ”‚ โ”œโ”€โ”€ {your files}            โ†’ Your media files (images, PDFs, videos, links)

CONTRIBUTING.md               โ†’ Contribution guidelines
favicon.png                   โ†’ Website icon
GUIDE.pdf                     โ†’ Detailed step-by-step user guide
index.html                    โ†’ Main website file
LICENSE.md                    โ†’ Template license
README.md                     โ†’ Quick start and overview

โš ๏ธ Important Notes

  • The ContentSee Template code is ยฉ 2025 Nael Aqel. Free for personal use only.
  • Commercial use requires contacting the author: nael@naelaqel.com
  • All media, text, or files uploaded to your website remain your property.
  • You may modify styling, layout, and HTML/CSS, or embed the template into your website.
  • Credit to Nael Aqel / ContentSee Template must remain in documentation or source code. It may be removed from the website footer if embedding.

๐Ÿ“– Documentation

๐Ÿ‘‰ See GUIDE.pdf for the full step-by-step guide (with screenshots).


๐Ÿ™Œ Credits

Developed by Nael Aqel.
Free for personal use only; commercial use requires contacting the author.


๐Ÿ’– Support & Connect

If this template helped you, please consider supporting me, it really makes a difference

  • โญ Star the repository and follow me on GitHub: github.com/NaelAqel
  • ๐Ÿ”— Share the template with anyone who could benefit from it
  • ๐Ÿ’ฐ Support financially via PayPal: paypal.me/naelaqel90
  • ๐Ÿ’ฌ Iโ€™d love to see your showcases, hear your feedback, or just connect!
    Iโ€™m very active on LinkedIn โ€” letโ€™s connect: linkedin.com/in/naelaqel1)
  • ๐ŸŒ You can also visit my website to explore my portfolio and articles: https://naelaqel.com

About

A simple, customizable website template to showcase (images, PDFs, audios, videos, and links). Built for non-technical users: configure everything in google sheets files and upload your media - no coding required.

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published