{"id":13731597,"url":"https://github.com/alertbox/try-docsify","last_synced_at":"2025-04-14T19:40:29.215Z","repository":{"id":41899652,"uuid":"271453996","full_name":"alertbox/try-docsify","owner":"alertbox","description":"A ready-to-go dev container for trying out docsify, magical static site generating tool for docs, static sites, et al.","archived":false,"fork":false,"pushed_at":"2023-03-25T08:28:21.000Z","size":528,"stargazers_count":11,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-10-01T09:09:10.131Z","etag":null,"topics":["devcontainer-template","devcontainers","docsify","github-pages","markdown","static-website"],"latest_commit_sha":null,"homepage":"https://alertbox.github.io/try-docsify/","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/alertbox.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}},"created_at":"2020-06-11T04:49:21.000Z","updated_at":"2024-08-13T05:50:19.000Z","dependencies_parsed_at":"2024-01-06T20:58:21.882Z","dependency_job_id":null,"html_url":"https://github.com/alertbox/try-docsify","commit_stats":null,"previous_names":["alertbox/try-docsify","alertbox/gh-quickstart","alertbox/vscode-remote-try-docsify"],"tags_count":2,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alertbox%2Ftry-docsify","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alertbox%2Ftry-docsify/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alertbox%2Ftry-docsify/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alertbox%2Ftry-docsify/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/alertbox","download_url":"https://codeload.github.com/alertbox/try-docsify/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248947947,"owners_count":21187779,"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":["devcontainer-template","devcontainers","docsify","github-pages","markdown","static-website"],"created_at":"2024-08-03T02:01:33.741Z","updated_at":"2025-04-14T19:40:29.181Z","avatar_url":"https://github.com/alertbox.png","language":"HTML","funding_links":[],"categories":["Dockerfile","markdown"],"sub_categories":[],"readme":"# Tryout Docsify\n\n[![alertbox](https://img.shields.io/badge/maintained%20by-alertbox-cc00ff.svg)](https://github.com/alertbox/devcontainers-try-docsify/)\n![GitHub repo size](https://img.shields.io/github/repo-size/alertbox/devcontainers-try-docsify)\n\n[\u003cimg align=\"right\" alt=\"Docsify devcontainer repo size\" width=\"128rem\" src=\"https://avatars.githubusercontent.com/u/40133106?s=200\u0026v=4\" /\u003e][docsify-quick-start]\n\nThis template repo serves as a flavor of ready-to-go development container for use with [Dev Containers][devcontainers-overview].\n\n\u003e Originally, this dev container was created to tryout ready-to-go docsify template that requires no build steps.\n\n[docsify-quick-start]: https://docsify.js.org/#/quickstart\n[devcontainers-overview]: https://containers.dev/supporting#dev-containers\n\n\n\n\u003cp align=\"center\"\u003e\n  \u003cimg alt=\"The docsify site in action\" src=\"Screenshot.png\" width=\"1024\"\u003e\n\u003c/p\u003e\n\n\n\u003e The dead simple docsify template in action.\n\n### What's included:\n\nTechnically, this includes nothing but:\n\n- A simple template found in [@docsifyjs/docsify-template][docsify-template-repo] repo\n- Configured to [preview locally](#quick-start), and\n- Powered by [Docsify][docsify-js] and [Open Dev Containers][devcontainers-overview]\n\n[docsify-template-repo]: https://github.com/docsifyjs/docsify-template\n[docsify-js]: https://docsify.js.org/\n\n\n\n## Requirements\n\nSee [dev containers][devcontainers-overview] to get started at the most basic level, and:\n- A GitHub account, and\n- A [Markdown][github-markdown-guides] editor, like [Typora][typora-install], a lightweight and easy-to-use syntax for all forms of writing on the GitHub platform\n\n[github-markdown-guides]: https://guides.github.com/features/mastering-markdown/\n[typora-install]: https://www.typora.io/\n\n\n\n## Quick Start\n\nIf you are completely new to docsify, the [Quick Start guide][docsify-quick-start] is a good source of information.\n\nJust upload the files to any static web server. Or follow this generic pattern:\n\nFirst, you want a copy of this repo. It is marked as a `Template` so you will only have to [Use this template][use-this-template] and follow the instructions. Read more about this in [the GitHub's Template Repositories][github-template-repos-help] document.\n\n[use-this-template]: https://github.com/alertbox/devcontainers-try-docsify/generate/\n[github-template-repos-help]: https://help.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-repository-from-a-template\n\n\n\nWith [Dev Container CLI][devcontainer-cli-commands]:\n\nJust run `devcontainer up devcontainers-try-docsify` in the repo. And that's it. Now you can [write more contents][docsify-write-more] and live preview on [localhost:3000](http://localhost:3000).\n\n[devcontainer-cli-commands]: https://github.com/devcontainers/cli#try-out-the-cli\n[docsify-write-more]: https://docsify.js.org/#/more-pages\n\n\n\nWith VS Code:\n\nFirst, run `code devcontainers-try-docsify/` in the repo to open in VS Code, and then it'll prompt to `Reopen in Container`. Do that and we're all set.\n\n\n\n## Known Issues\n\n- https://github.com/docsifyjs/docsify-cli/issues/26#issuecomment-1483757192\n- https://github.com/docsifyjs/docsify-cli/issues/120#issuecomment-1483753553\n\n## Learning Resources\n\n- [GitHub Learning Lab for GitHub Pages](https://lab.github.com/githubtraining/github-pages)\n- [Mastering Markdown](https://guides.github.com/features/mastering-markdown/)\n- [Create GitHub Pages with Docsify](https://www.youtube.com/watch?v=TV88lp7egMw)\n- [Creating additional pages and content using Docsify](https://docsify.js.org/#/more-pages)\n\n\u003e [Awesome Lists](https://github.com/sindresorhus/awesome) are curated lists of awesome stuff. But, what is awesome?\n\n[Awesome Docsify](https://github.com/docsifyjs/awesome-docsify/) | [GitHub Cheat Sheet](https://github.com/tiimgreen/github-cheat-sheet)\n\n\n\n## Feedback\n\nIf you have any technical problems with Docsify, you are better off [asking Docsify Support directly][docsify-support], since you'll end up getting a much faster response back that way.\n\n[docsify-support]: https://discord.gg/3NwKFyR\n\n## Contributing\n\nThe official repo to contribute would be [@docsifyjs][docsify-github].\n\n[docsify-github]: https://github.com/docsifyjs\n\n\n\n## License\n\nCopyright (c) Alertbox Inc. All rights reserved.\n\nThe source code is license under the [MIT License](LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falertbox%2Ftry-docsify","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Falertbox%2Ftry-docsify","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falertbox%2Ftry-docsify/lists"}