{"id":23315183,"url":"https://github.com/maverickg59/docsify-template","last_synced_at":"2026-01-20T05:02:09.610Z","repository":{"id":268216003,"uuid":"903662263","full_name":"maverickg59/docsify-template","owner":"maverickg59","description":"Simple template to help bootstrap a docsify project as quickly as possible in my favorite setup.","archived":false,"fork":false,"pushed_at":"2024-12-17T05:40:53.000Z","size":107,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"develop","last_synced_at":"2025-04-07T03:29:50.564Z","etag":null,"topics":["docsify","docsify-template"],"latest_commit_sha":null,"homepage":"https://docsify-template.chriswhite.rocks","language":null,"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/maverickg59.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-12-15T07:59:43.000Z","updated_at":"2024-12-17T05:40:57.000Z","dependencies_parsed_at":"2024-12-15T09:27:12.331Z","dependency_job_id":"ac90ea8e-644b-49c8-81e6-183646af12e8","html_url":"https://github.com/maverickg59/docsify-template","commit_stats":null,"previous_names":["maverickg59/docsify-template"],"tags_count":1,"template":true,"template_full_name":null,"purl":"pkg:github/maverickg59/docsify-template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maverickg59%2Fdocsify-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maverickg59%2Fdocsify-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maverickg59%2Fdocsify-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maverickg59%2Fdocsify-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/maverickg59","download_url":"https://codeload.github.com/maverickg59/docsify-template/tar.gz/refs/heads/develop","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maverickg59%2Fdocsify-template/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28596087,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-20T02:08:49.799Z","status":"ssl_error","status_checked_at":"2026-01-20T02:08:44.148Z","response_time":117,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["docsify","docsify-template"],"created_at":"2024-12-20T15:31:18.158Z","updated_at":"2026-01-20T05:02:09.592Z","avatar_url":"https://github.com/maverickg59.png","language":null,"readme":"# docsify-template\n\n\u003cdiv style=\"display: flex; align-items: center;\"\u003e\n  \u003ca href=\"https://docsify.js.org/#/\"\u003e\n    \u003cimg\n      style=\"height: auto; width: 60px;\"\n      src=\"./docs/assets/icon.svg\"\n    \u003e\n  \u003c/a\u003e\n  \u003cspan style=\"margin-left: 10px; font-size: 20px;\"\u003e\n    A simple template to help bootstrap a Docsify project as quickly as possible, configured with my favorite setup.\n  \u003c/span\u003e\n\u003c/div\u003e\n\n## Version\n\nCurrent version: `1.0.0`\n\n## Features\n\n- **Quick Bootstrap**: Preconfigured project structure to get you started instantly.\n- **Customizable Components**: Easily swap out the logo (`cw_rocks.png`), favicon (`favicon.ico`), and footer content to personalize your site.\n- **Enhanced Functionality**:\n  - Integrated [docsify-copy-code](https://github.com/jperasmus/docsify-copy-code) for effortless code snippet copying.\n  - Includes [docsify-footer](https://github.com/alertbox/docsify-footer) for consistent document footers.\n  - Search functionality powered by [docsify-search](https://github.com/docsifyjs/docsify).\n  - Themed using [docsify-theme-github](https://github.com/LIGMATV/docsify-theme-github)\n  - GitHub corner provided by [docsify-corner](https://github.com/Koooooo-7/docsify-corner)\n- **Simple Local Preview**: Run a Python server to preview your site locally with a single command.\n\n---\n\n## Project Structure\n\n```plaintext\n./docs/\n├── assets/\n│   ├── copycode.js      # Copy Code script (enables code copy/paste)\n│   ├── docsify.js       # Core Docsify script\n│   ├── corner.js        # Corner script (enables GitHub corner)\n│   ├── footer.js        # Footer script (enables footer on every page)\n│   ├── icon.svg         # Docsify logo\n│   ├── index.css        # Theme stylesheet\n│   ├── search.js        # Search script (enables search)\n├── _footer.md           # Defines the document footer\n├── .nojekyll            # Tells GitHub to bypass Jekyll\n├── CNAME                # Adds custom domain to my pages site (replace or delete)\n├── cw_rocks.png         # Logo (replace with your own)\n├── favicon.ico          # Favicon (replace with your own)\n├── index.html           # Main entry point for the Docsify site\n├── license.md           # MIT license file\n├── makefile             # Includes a command to run a local preview\n└── README.md            # Project documentation\n```\n\n## Usage\n\n### 1. Clone the Repository\n\n```bash\ngit clone https://github.com/maverickg59/docsify-template.git\ncd docsify-template\n```\n\n### 2. Start the Local Server\n\nTo preview your site locally, use the `makefile`:\n\n```bash\ncd docs\n\nmake dev\n```\n\nThis runs a Python server at `http://localhost:3005`.\n\nAlternatively, run the server manually:\n\n```bash\npython3 -m http.server 3005\n```\n\n### 3. Customize\n\n- Replace `cw_rocks.png` with your logo.\n- Replace `favicon.ico` with your favicon.\n- Modify `_footer.md` to update the footer content.\n- Update the Docsify config inside `index.html`.\n- Modify the features to your hearts content.\n- Visit [Docsify docs](https://docsify.js.org/#/?id=docsify) to get started developing content.\n\n---\n\n## Built With\n\n- [docsify](https://github.com/docsifyjs/docsify): A magical documentation site generator.\n- [docsify-copy-code](https://github.com/jperasmus/docsify-copy-code): Adds a copy button to code blocks.\n- [docsify-footer](https://github.com/alertbox/docsify-footer): Allows customization of the footer.\n- [docsify-search](https://github.com/docsifyjs/docsify): Provides in-page search functionality.\n- [docsify-theme-github](https://github.com/LIGMATV/docsify-theme-github): The minimal amount of CSS to replicate the GitHub Markdown style.\n- [docsify-corner](https://github.com/Koooooo-7/docsify-corner): Provides the GitHub corner to help users find your repo quickly and easily.\n\n---\n\n## License\n\nThis project is licensed under the MIT License. See the [LICENSE](./LICENSE) file for details.\n\n---\n\n## Contributing\n\nContributions are welcome! Feel free to submit a pull request or open an issue on [GitHub](https://github.com/maverickg59/docsify-template).\n\n---\n\n## Author\n\nDeveloped by [Chris White](https://chriswhite.rocks). Find me on [GitHub](https://github.com/maverickg59).\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmaverickg59%2Fdocsify-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmaverickg59%2Fdocsify-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmaverickg59%2Fdocsify-template/lists"}