{"id":18155246,"url":"https://github.com/M7mdJs/Docs-Website","last_synced_at":"2025-03-31T17:32:48.097Z","repository":{"id":260519050,"uuid":"881527293","full_name":"M7mdJs/Docs-Website","owner":"M7mdJs","description":"An elegant, user-friendly website template for presenting NPM package documentation. This project organizes key information such as features, policies, and terms in one cohesive, easy-to-navigate place.","archived":false,"fork":false,"pushed_at":"2024-11-13T11:47:25.000Z","size":133,"stargazers_count":2,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-19T18:52:51.838Z","etag":null,"topics":["css","css3","docs","html","html-css-javascript","html5","javascript","jquery","website","website-design","website-template"],"latest_commit_sha":null,"homepage":"https://docs-website.netlify.app/","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/M7mdJs.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-10-31T18:48:51.000Z","updated_at":"2024-11-13T11:47:29.000Z","dependencies_parsed_at":"2024-10-31T19:31:47.360Z","dependency_job_id":"82350bc5-6830-4770-b524-24558f5d9b4b","html_url":"https://github.com/M7mdJs/Docs-Website","commit_stats":null,"previous_names":["srwitty/docs-website","m7mdjs/docs-website"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/M7mdJs%2FDocs-Website","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/M7mdJs%2FDocs-Website/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/M7mdJs%2FDocs-Website/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/M7mdJs%2FDocs-Website/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/M7mdJs","download_url":"https://codeload.github.com/M7mdJs/Docs-Website/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246509284,"owners_count":20789140,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["css","css3","docs","html","html-css-javascript","html5","javascript","jquery","website","website-design","website-template"],"created_at":"2024-11-02T04:09:57.187Z","updated_at":"2025-03-31T17:32:48.089Z","avatar_url":"https://github.com/M7mdJs.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 📦 NPM Pack Documentation Website\r\n\r\nAn elegant, user-friendly website template for presenting **NPM package documentation**. This project organizes key information such as features, policies, and terms in one cohesive, easy-to-navigate place.\r\n\r\n---\r\n\r\n## 🌐 Web Preview\r\n\r\nPreview the live site here: [Docs Website Preview](https://docs-website.netlify.app/)  \r\n\r\n\r\n---\r\n\r\n## 📖 Project Overview\r\n\r\nThis website template offers a streamlined approach for displaying documentation and essential information about an NPM package. With responsive design and clear navigation, it enhances the user experience by organizing all important details in one place.\r\n\r\n## ✨ Key Features\r\n\r\n- **🏠 Home Page**: Welcoming main page with intuitive navigation.\r\n- **📄 Documentation**: Comprehensive usage examples, installation steps, and functionality descriptions.\r\n- **👥 About**: Background of the package, its purpose, and core developers.\r\n- **📑 License, Privacy, \u0026 Terms**: Pages to provide clear legal guidelines and user rights.\r\n- **📱 Responsive Design**: Optimized for desktops, tablets, and mobile devices.\r\n- **🧭 Easy Navigation**: User-friendly menu with links to all essential sections.\r\n\r\n## 🛠 Tech Stack\r\n\r\n- **HTML**: Structure and organization of content.\r\n- **CSS (Tailwind)**: Clean, modern, and responsive styling.\r\n- **JavaScript**: Enhances interactivity and user experience.\r\n\r\n## 🚀 Installation and Setup\r\n\r\nTo run the project locally:\r\n\r\n1. **Clone the repository**:\r\n    ```bash\r\n    git clone https://github.com/M7mdJs/Docs-Website.git\r\n    ```\r\n2. **Navigate to the project folder**:\r\n    ```bash\r\n    cd Docs-Website\r\n    ```\r\n3. **Open `home.html` in your browser**:\r\n   - Double-click the file or use a live server to preview.\r\n\r\n---\r\n\r\n## 📂 File Structure\r\n\r\n- **home.html** - The primary landing page for the site.\r\n- **css/** - Stylesheets for each section:\r\n  - `style.css` - General styles across all pages.\r\n  - `docs.css`, `license.css`, `privacy.css`, `terms.css` - Specific styles for each section.\r\n- **images/** - Holds images, including profile and other visuals.\r\n- **js/** - JavaScript files for interactive elements:\r\n  - `main.js` - Core functionalities.\r\n  - `docs.js` - Manages interactions on the documentation page.\r\n- **pages/** - HTML files for specific sections:\r\n  - `about.html` - About page with package background.\r\n  - `docs.html` - Detailed documentation.\r\n  - `license.html` - License agreement.\r\n  - `privacy.html` - Privacy policy.\r\n  - `terms.html` - Terms of service.\r\n\r\n## 🧭 Usage Guide\r\n\r\n1. **Open `home.html`** in a browser to access the homepage.\r\n2. **Navigate** through the menu for **About**, **Docs**, **License**, **Privacy**, and **Terms** sections.\r\n3. **Explore** the documentation page for installation, usage, and examples; other pages provide critical legal and policy details.\r\n\r\n---\r\n\r\n## 👤 Developer Information\r\n\r\nFor assistance or inquiries, please reach out to the developer:\r\n\r\n-  [Developer's GitHub Profile](https://github.com/M7mdJs)\r\n-  [Developer's Discord](https://discord.com/users/1091118468155314306)\r\n-  [Developer's Website](https://m7mjs.pages.dev/)\r\n\r\n---\r\n\r\n## 📝 License\r\n\r\nThis project is open-source and available under the **MIT License**.\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FM7mdJs%2FDocs-Website","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FM7mdJs%2FDocs-Website","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FM7mdJs%2FDocs-Website/lists"}