├── .devcontainer └── devcontainer.json ├── .dockerignore ├── .gitignore ├── .nojekyll ├── .npmrc ├── .vscode └── extensions.json ├── LICENSE ├── README.md ├── Screenshot.png └── index.html /.devcontainer/devcontainer.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "try-docsify", 3 | // See complete list https://hub.docker.com/_/node/tags?page=1&name=bullseye 4 | "image": "mcr.microsoft.com/devcontainers/base:ubuntu", 5 | // Use 'forwardPorts' to make a list of ports inside the container available locally. 6 | "forwardPorts": [ 7 | // Localhost 8 | 3000, 9 | // Live reload 10 | 35729 11 | ], 12 | 13 | // Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root. 14 | "remoteUser": "root", 15 | 16 | // Add more features. See complete list https://github.com/devcontainers/features 17 | "features": { 18 | // Permission denied. More info: https://github.com/devcontainers/features/issues/440 19 | "ghcr.io/devcontainers/features/common-utils:2": { 20 | "configureZshAsDefaultShell": true 21 | }, 22 | "ghcr.io/devcontainers/features/github-cli:1": {}, 23 | "ghcr.io/devcontainers/features/node:1": "lts", 24 | "ghcr.io/alertbox/oven-sh/bun:1": { 25 | "packages": "docsify-cli@latest" 26 | } 27 | }, 28 | "containerEnv": {}, 29 | // Configure tool-specific properties. 30 | "customizations": { 31 | // Configure properties specific to VS Code. 32 | "vscode": { 33 | // Add the IDs of extensions you want installed when the container is created. 34 | "extensions": [ 35 | "editorconfig.editorconfig", 36 | "redhat.vscode-yaml", 37 | "tamasfe.even-better-toml", 38 | 39 | "visualstudioexptteam.vscodeintellicode", 40 | "dbaeumer.vscode-eslint", 41 | "christian-kohler.npm-intellisense", 42 | 43 | "glenn2223.live-sass", 44 | "esbenp.prettier-vscode", 45 | "bierner.github-markdown-preview", 46 | "streetsidesoftware.code-spell-checker", 47 | "redhat.fabric8-analytics" 48 | ], 49 | // Set *default* container specific settings.json values on container create. 50 | "settings": { 51 | "terminal.integrated.defaultProfile.linux": "zsh", 52 | "editor.guides.bracketPairs": "active", 53 | "debug.internalConsoleOptions": "neverOpen", 54 | "scm.defaultViewMode": "tree", 55 | "files.watcherExclude": { 56 | "**/node_modules/**": true 57 | } 58 | } 59 | } 60 | }, 61 | 62 | // Use 'updateContentCommand' to run commands after the container is successfully created. 63 | // "updateContentCommand": "yarn global add docsify-cli@latest --prefix /usr/local", 64 | // Use 'postCreateCommand' to run commands after the container is created. 65 | "postCreateCommand": "docsify serve . -P 35729" 66 | } 67 | -------------------------------------------------------------------------------- /.dockerignore: -------------------------------------------------------------------------------- 1 | # 2 | # macOS ignores 3 | # 4 | 5 | # General 6 | .DS_Store 7 | .AppleDouble 8 | .LSOverride 9 | 10 | # Icon must end with two \r 11 | Icon 12 | 13 | 14 | # Thumbnails 15 | ._* 16 | 17 | # Files that might appear in the root of a volume 18 | .DocumentRevisions-V100 19 | .fseventsd 20 | .Spotlight-V100 21 | .TemporaryItems 22 | .Trashes 23 | .VolumeIcon.icns 24 | .com.apple.timemachine.donotpresent 25 | 26 | # Directories potentially created on remote AFP share 27 | .AppleDB 28 | .AppleDesktop 29 | Network Trash Folder 30 | Temporary Items 31 | .apdisk 32 | 33 | # 34 | # Windows ignores 35 | # 36 | 37 | # Windows thumbnail cache files 38 | Thumbs.db 39 | Thumbs.db:encryptable 40 | ehthumbs.db 41 | ehthumbs_vista.db 42 | 43 | # Dump file 44 | *.stackdump 45 | 46 | # Folder config file 47 | [Dd]esktop.ini 48 | 49 | # Recycle Bin used on file shares 50 | $RECYCLE.BIN/ 51 | 52 | # Windows Installer files 53 | *.cab 54 | *.msi 55 | *.msix 56 | *.msm 57 | *.msp 58 | 59 | # Windows shortcuts 60 | *.lnk 61 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # 2 | # Project Specific Ignores 3 | # 4 | 5 | # 6 | # VS Code Ignores 7 | # 8 | .vscode/* 9 | !.vscode/settings.json 10 | !.vscode/tasks.json 11 | !.vscode/launch.json 12 | !.vscode/extensions.json 13 | *.code-workspace 14 | 15 | # Local History for Visual Studio Code 16 | .history/ 17 | 18 | # 19 | # NodeJS Ignores 20 | # 21 | 22 | # Logs 23 | logs 24 | *.log 25 | npm-debug.log* 26 | yarn-debug.log* 27 | yarn-error.log* 28 | lerna-debug.log* 29 | 30 | # Diagnostic reports (https://nodejs.org/api/report.html) 31 | report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json 32 | 33 | # Runtime data 34 | pids 35 | *.pid 36 | *.seed 37 | *.pid.lock 38 | 39 | # Directory for instrumented libs generated by jscoverage/JSCover 40 | lib-cov 41 | 42 | # Coverage directory used by tools like istanbul 43 | coverage 44 | *.lcov 45 | 46 | # nyc test coverage 47 | .nyc_output 48 | 49 | # Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files) 50 | .grunt 51 | 52 | # Bower dependency directory (https://bower.io/) 53 | bower_components 54 | 55 | # node-waf configuration 56 | .lock-wscript 57 | 58 | # Compiled binary addons (https://nodejs.org/api/addons.html) 59 | build/Release 60 | 61 | # Dependency directories 62 | node_modules/ 63 | jspm_packages/ 64 | 65 | # TypeScript v1 declaration files 66 | typings/ 67 | 68 | # TypeScript cache 69 | *.tsbuildinfo 70 | 71 | # Optional npm cache directory 72 | .npm 73 | 74 | # Optional eslint cache 75 | .eslintcache 76 | 77 | # Microbundle cache 78 | .rpt2_cache/ 79 | .rts2_cache_cjs/ 80 | .rts2_cache_es/ 81 | .rts2_cache_umd/ 82 | 83 | # Optional REPL history 84 | .node_repl_history 85 | 86 | # Output of 'npm pack' 87 | *.tgz 88 | 89 | # Yarn Integrity file 90 | .yarn-integrity 91 | 92 | # dotenv environment variables file 93 | .env 94 | .env.test 95 | 96 | # parcel-bundler cache (https://parceljs.org/) 97 | .cache 98 | 99 | # Next.js build output 100 | .next 101 | 102 | # Nuxt.js build / generate output 103 | .nuxt 104 | dist 105 | 106 | # Gatsby files 107 | .cache/ 108 | # Comment in the public line in if your project uses Gatsby and *not* Next.js 109 | # https://nextjs.org/blog/next-9-1#public-directory-support 110 | # public 111 | 112 | # vuepress build output 113 | .vuepress/dist 114 | 115 | # Serverless directories 116 | .serverless/ 117 | 118 | # FuseBox cache 119 | .fusebox/ 120 | 121 | # DynamoDB Local files 122 | .dynamodb/ 123 | 124 | # TernJS port file 125 | .tern-port 126 | 127 | # 128 | # macOS ignores 129 | # 130 | 131 | # General 132 | .DS_Store 133 | .AppleDouble 134 | .LSOverride 135 | 136 | # Icon must end with two \r 137 | Icon 138 | 139 | 140 | # Thumbnails 141 | ._* 142 | 143 | # Files that might appear in the root of a volume 144 | .DocumentRevisions-V100 145 | .fseventsd 146 | .Spotlight-V100 147 | .TemporaryItems 148 | .Trashes 149 | .VolumeIcon.icns 150 | .com.apple.timemachine.donotpresent 151 | 152 | # Directories potentially created on remote AFP share 153 | .AppleDB 154 | .AppleDesktop 155 | Network Trash Folder 156 | Temporary Items 157 | .apdisk 158 | 159 | # 160 | # Windows ignores 161 | # 162 | 163 | # Windows thumbnail cache files 164 | Thumbs.db 165 | Thumbs.db:encryptable 166 | ehthumbs.db 167 | ehthumbs_vista.db 168 | 169 | # Dump file 170 | *.stackdump 171 | 172 | # Folder config file 173 | [Dd]esktop.ini 174 | 175 | # Recycle Bin used on file shares 176 | $RECYCLE.BIN/ 177 | 178 | # Windows Installer files 179 | *.cab 180 | *.msi 181 | *.msix 182 | *.msm 183 | *.msp 184 | 185 | # Windows shortcuts 186 | *.lnk 187 | -------------------------------------------------------------------------------- /.nojekyll: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/alertbox/try-docsify/0b3d07cc23865c9f0c854d3138b907bed8396130/.nojekyll -------------------------------------------------------------------------------- /.npmrc: -------------------------------------------------------------------------------- 1 | save = true 2 | save-exact = true 3 | loglevel = error 4 | package-lock = false 5 | strict-ssl = false 6 | dev = true -------------------------------------------------------------------------------- /.vscode/extensions.json: -------------------------------------------------------------------------------- 1 | { 2 | "recommendations": [ 3 | "ms-azuretools.vscode-containers", 4 | "ms-vscode-remote.remote-containers", 5 | "redhat.vscode-yaml", 6 | "editorconfig.editorconfig", 7 | ] 8 | } 9 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2020 Alertbox Inc. 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Tryout Docsify 2 | 3 | [![alertbox](https://img.shields.io/badge/maintained%20by-alertbox-cc00ff.svg)](https://github.com/alertbox/devcontainers-try-docsify/) 4 | ![GitHub repo size](https://img.shields.io/github/repo-size/alertbox/devcontainers-try-docsify) 5 | 6 | [Docsify devcontainer repo size][docsify-quick-start] 7 | 8 | This template repo serves as a flavor of ready-to-go development container for use with [Dev Containers][devcontainers-overview]. 9 | 10 | > Originally, this dev container was created to tryout ready-to-go docsify template that requires no build steps. 11 | 12 | [docsify-quick-start]: https://docsify.js.org/#/quickstart 13 | [devcontainers-overview]: https://containers.dev/supporting#dev-containers 14 | 15 | 16 | 17 |

18 | The docsify site in action 19 |

20 | 21 | 22 | > The dead simple docsify template in action. 23 | 24 | ### What's included: 25 | 26 | Technically, this includes nothing but: 27 | 28 | - A simple template found in [@docsifyjs/docsify-template][docsify-template-repo] repo 29 | - Configured to [preview locally](#quick-start), and 30 | - Powered by [Docsify][docsify-js] and [Open Dev Containers][devcontainers-overview] 31 | 32 | [docsify-template-repo]: https://github.com/docsifyjs/docsify-template 33 | [docsify-js]: https://docsify.js.org/ 34 | 35 | 36 | 37 | ## Requirements 38 | 39 | See [dev containers][devcontainers-overview] to get started at the most basic level, and: 40 | - A GitHub account, and 41 | - 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 42 | 43 | [github-markdown-guides]: https://guides.github.com/features/mastering-markdown/ 44 | [typora-install]: https://www.typora.io/ 45 | 46 | 47 | 48 | ## Quick Start 49 | 50 | If you are completely new to docsify, the [Quick Start guide][docsify-quick-start] is a good source of information. 51 | 52 | Just upload the files to any static web server. Or follow this generic pattern: 53 | 54 | First, 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. 55 | 56 | [use-this-template]: https://github.com/alertbox/devcontainers-try-docsify/generate/ 57 | [github-template-repos-help]: https://help.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-repository-from-a-template 58 | 59 | 60 | 61 | With [Dev Container CLI][devcontainer-cli-commands]: 62 | 63 | Just 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). 64 | 65 | [devcontainer-cli-commands]: https://github.com/devcontainers/cli#try-out-the-cli 66 | [docsify-write-more]: https://docsify.js.org/#/more-pages 67 | 68 | 69 | 70 | With VS Code: 71 | 72 | First, 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. 73 | 74 | 75 | 76 | ## Known Issues 77 | 78 | - https://github.com/docsifyjs/docsify-cli/issues/26#issuecomment-1483757192 79 | - https://github.com/docsifyjs/docsify-cli/issues/120#issuecomment-1483753553 80 | 81 | ## Learning Resources 82 | 83 | - [GitHub Learning Lab for GitHub Pages](https://lab.github.com/githubtraining/github-pages) 84 | - [Mastering Markdown](https://guides.github.com/features/mastering-markdown/) 85 | - [Create GitHub Pages with Docsify](https://www.youtube.com/watch?v=TV88lp7egMw) 86 | - [Creating additional pages and content using Docsify](https://docsify.js.org/#/more-pages) 87 | 88 | > [Awesome Lists](https://github.com/sindresorhus/awesome) are curated lists of awesome stuff. But, what is awesome? 89 | 90 | [Awesome Docsify](https://github.com/docsifyjs/awesome-docsify/) | [GitHub Cheat Sheet](https://github.com/tiimgreen/github-cheat-sheet) 91 | 92 | 93 | 94 | ## Feedback 95 | 96 | If 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. 97 | 98 | [docsify-support]: https://discord.gg/3NwKFyR 99 | 100 | ## Contributing 101 | 102 | The official repo to contribute would be [@docsifyjs][docsify-github]. 103 | 104 | [docsify-github]: https://github.com/docsifyjs 105 | 106 | 107 | 108 | ## License 109 | 110 | Copyright (c) Alertbox Inc. All rights reserved. 111 | 112 | The source code is license under the [MIT License](LICENSE). 113 | -------------------------------------------------------------------------------- /Screenshot.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/alertbox/try-docsify/0b3d07cc23865c9f0c854d3138b907bed8396130/Screenshot.png -------------------------------------------------------------------------------- /index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | Docsify - A ready-to-go template 6 | 7 | 9 | 10 | 11 | 12 | 13 |
14 | 35 | 36 | 37 | 38 | 39 | 40 | --------------------------------------------------------------------------------