{"id":16551259,"url":"https://github.com/michaelcurrin/docsify-js-template","last_synced_at":"2025-08-02T06:06:03.780Z","repository":{"id":37897112,"uuid":"253191289","full_name":"MichaelCurrin/docsify-js-template","owner":"MichaelCurrin","description":"Starter template for a Markdown-based docs site 📒 🕸","archived":false,"fork":false,"pushed_at":"2022-06-14T19:20:54.000Z","size":1391,"stargazers_count":19,"open_issues_count":11,"forks_count":25,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-04-04T15:53:52.250Z","etag":null,"topics":["demo","docs-site","docsify","docsify-template","documentation","github-pages","simplest","template"],"latest_commit_sha":null,"homepage":"https://michaelcurrin.github.io/docsify-js-template/#/","language":"Shell","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/MichaelCurrin.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}},"created_at":"2020-04-05T08:45:11.000Z","updated_at":"2024-08-26T04:11:28.000Z","dependencies_parsed_at":"2022-07-09T10:30:41.447Z","dependency_job_id":null,"html_url":"https://github.com/MichaelCurrin/docsify-js-template","commit_stats":null,"previous_names":[],"tags_count":4,"template":true,"template_full_name":null,"purl":"pkg:github/MichaelCurrin/docsify-js-template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MichaelCurrin%2Fdocsify-js-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MichaelCurrin%2Fdocsify-js-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MichaelCurrin%2Fdocsify-js-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MichaelCurrin%2Fdocsify-js-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/MichaelCurrin","download_url":"https://codeload.github.com/MichaelCurrin/docsify-js-template/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MichaelCurrin%2Fdocsify-js-template/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":268339637,"owners_count":24234553,"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","status":"online","status_checked_at":"2025-08-02T02:00:12.353Z","response_time":74,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":["demo","docs-site","docsify","docsify-template","documentation","github-pages","simplest","template"],"created_at":"2024-10-11T19:36:46.197Z","updated_at":"2025-08-02T06:06:03.747Z","avatar_url":"https://github.com/MichaelCurrin.png","language":"Shell","readme":"# DocsifyJS Template 📒 🕸\n\u003e Starter template for a Markdown-based docs site\n\n[![GitHub tag](https://img.shields.io/github/tag/MichaelCurrin/docsify-js-template)](https://github.com/MichaelCurrin/docsify-js-template/tags/?include_prereleases\u0026sort=semver)\n[![License](https://img.shields.io/badge/License-MIT-blue)](#license)\n\n[![Made with latest Docsify](https://img.shields.io/badge/docsify-v4-blue?label=docsify)](https://docsify.js.org/ \"Go to Docsify website\")\n[![Hosted with GH Pages](https://img.shields.io/badge/Hosted_with-GitHub_Pages-blue?logo=github\u0026logoColor=white)](https://pages.github.com/ \"Go to GitHub Pages docs\")\n\n\n## Preview\n\n\u003cdiv align=\"center\"\u003e\n    \u003ca href=\"https://michaelcurrin.github.io/docsify-js-template/\"\u003e\n        \u003cimg src=\"/sample.png\" alt=\"Sample screenshot\" alt=\"Go to website\" width=\"500\" /\u003e\n    \u003c/a\u003e\n\u003c/div\u003e\n\n\u003cbr\u003e\n\n\u003cdiv align=\"center\"\u003e\n\n[![View site - GH Pages](https://img.shields.io/badge/View_site-GH_Pages-blue?style=for-the-badge)](https://michaelcurrin.github.io/docsify-js-template/ \"Go to website\")\n\nInstead of forking, rather make a new repo using this template button:\n\n[![Use this template](https://img.shields.io/badge/Generate-Use_this_template-2ea44f?style=for-the-badge)](https://github.com/MichaelCurrin/docsify-js-template/generate)\n\n\u003c/div\u003e\n\nIf you want to improve the original template, then fork it and make a PR.\n\n\n## Features\n\n- 🏭 Template for a SPA modern docs site.\n- 📗 Use your awesome project's _existing_ markdown files.\n- 🤩 Light on code – just add a single HTML file and optionally add cover page and navbar config.\n- 🚀 Easy to host as a static site on GitHub Pages. No build step needed.\n\n\n## Purpose\n\u003e How to use this project\n\n- Create a **new repo** from the template and host it on GitHub Pages immediately. This is good for trying out Docsify or building a site project from scratch.\n- Use this project as a **base** - follow instructions to download just the necessary files to your _existing_ repo's `docs` directory\n- View the **live** demo site to see what you'll get.\n\nFor more info on Docsify, see my [DocsifyJS Tutorial][]. That covers intro to DocsifyJS, including installation, running and configuration. If you look at the repo, that has has more content and configuration than this relatively plain template site.\n\n[DocsifyJS Tutorial]: https://michaelcurrin.github.io/docsify-js-tutorial/#/\n\n\n## How to use Docsify in your projects\n\n### Copy files\n\nUse one of the approaches below to setup Docsify in your own project.\n\n#### A. Use this template\n\nCreate a _new_ forked project based on this template  by clicking the button below. You'll get a fork in your own repo.\n\n[![Use this template](https://img.shields.io/badge/Use_this_template-2ea44f)](https://github.com/MichaelCurrin/docsify-js-template/generate)\n\nYou could start adding code outside of the _docs_ directory, however this project is intended as a standalone docs site which can be configured for experimentation and used as reference.\n\n#### B. Add Docsify to an existing project's docs directory\n\nThis will copy the contents of the docs directory from Github to the current folder - ideal if there is an existing project and you want to add to _Docsify_ it.\n\n1. Ensure you have `curl` command installed. Or use `wget`.\n2. Navigate to your project's `docs` folder.\n    ```sh\n    cd my-project/docs\n    ```\n3. Download necessary files in the template [docs](/docs) directory to your project using this two-line command. (The `-O` flag will save the files locally, keeping the original filenames.)\n    ```sh\n    REPO_DOCS='https://raw.githubusercontent.com/MichaelCurrin/docsify-js-template/master/docs/'\n    curl $REPO_DOCS\\{_coverpage.md,_sidebar.md,.nojekyll,index.html,README.md\\} -O\n    ```\n\n### Customize\n\nYou can use your IDE to do find and replace across files.\n\nUse the convenient [replace.sh](/replace.sh) script in this repo to replace the template's values with your own.\n\n\n1. Find the script.\n    - If you used the template button, you've already got it.\n    - If adding content to your existing project's docs, copy script to your project **root** (not docs directory)\n        ```sh\n        curl 'https://raw.githubusercontent.com/MichaelCurrin/docsify-js-template/master/replace.sh' -O\n        chmod +x ./replace.sh\n        ```\n2. Modify the `MY_` values then run this script to replace the template's value with your own.\n3. Run the script from the **project root** against yours docs directory.\n   ```sh\n   ./replace.sh\n   ```\n4. The script can be deleted after you use it.\n\nNow complete any remaining TODO items in the files.\n\n### Use template readme\n\nIf you clicked _Use this template_, followed the customize steps above, then the last thing to do is replace the project's README.md file with the template one.\n\n```sh\nmv README.template.md README.md\n```\n\nThen customize README.md as your own project.\n\n\n## Set up and run\n\n### Remote use\n\nWhatever approach you use to set up a `docs` directory, you can use your own project or a forked template and serve your site on platform like  GiHhub Pages or Netlify.\n\nThis template still works fine as a standalone online demo of _Docsify_ that you can tweak. In a real project, you'd add your code at the repo root, outside of `docs`. Or you could move your docs site to the repo root on the `gh-pages` branch for GH Pages.\n\n### Serve locally\n\nFollow this [gist](https://gist.github.com/MichaelCurrin/4c8060dcc9d8841f842eeebc7a1436d8) so you can view the docs site on a local webserver.\n\nGo to my [DocsifyJS Tutorial - Serve locally](https://michaelcurrin.github.io/docsify-js-tutorial/#/?id=serve-a-docsify-site-locally) for more info on what DocsifyJS is and how to use it.\n\n\n## Related projects\n\nA template using Docsify Themeable. It is a Docsify site but easier to use, it is prettier (in my opinion), and supports a theme system that is more advanced than that in Docsify.\n\n- [![MichaelCurrin - docsify-themeable-quickstart](https://img.shields.io/static/v1?label=MichaelCurrin\u0026message=docsify-themeable-quickstart\u0026color=blue\u0026logo=github)](https://github.com/MichaelCurrin/docsify-themeable-quickstart)\n\nA template for Vue-based docs site. Except it uses VuePress to render a static site (better for SEO) rather than as a Single-Page Application like Docsify.\n \n- [![MichaelCurrin - vuepress-quickstart](https://img.shields.io/static/v1?label=MichaelCurrin\u0026message=vuepress-quickstart\u0026color=blue\u0026logo=github)](https://github.com/MichaelCurrin/vuepress-quickstart)\n\nA template for a Vue-based app.\n\n- [![MichaelCurrin - vue-quickstart](https://img.shields.io/static/v1?label=MichaelCurrin\u0026message=vue-quickstart\u0026color=blue\u0026logo=github)](https://github.com/MichaelCurrin/vue-quickstart)\n\n\n## License\n\nReleased under [MIT](/LICENSE) by [@MichaelCurrin](https://github.com/MichaelCurrin).\n\n- You can modify and reuse this project.\n- Please link back to the original repo somewhere in your project if you use this in any way.\n- Including an original license copy.\n    - If you add content from [docs](/docs/) to your repo (or click _Use this template_) and then modify for your own needs so your copy is no longer a template, then you don't need to include a license.\n    - If you do fork this repo then use it as your own _template_, then this project's license and copyright notice must be **included** with the software. [source](https://choosealicense.com/licenses/#mit). Copy `LICENSE` to `LICENSE-source` and then update your copy of `LICENSE` with your own details.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmichaelcurrin%2Fdocsify-js-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmichaelcurrin%2Fdocsify-js-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmichaelcurrin%2Fdocsify-js-template/lists"}