Tryout Docsify
This template repo serves as a flavor of ready-to-go development container for use with Dev Containers.
Originally, this dev container was created to tryout ready-to-go docsify template that requires no build steps.
The dead simple docsify template in action.
What's included:
Technically, this includes nothing but:
- A simple template found in @docsifyjs/docsify-template repo
- Configured to preview locally, and
- Powered by Docsify and Open Dev Containers
Requirements
See dev containers to get started at the most basic level, and:
- A GitHub account, and
- A Markdown editor, like Typora, a lightweight and easy-to-use syntax for all forms of writing on the GitHub platform
Quick Start
If you are completely new to docsify, the Quick Start guide is a good source of information.
Just upload the files to any static web server. Or follow this generic pattern:
First, you want a copy of this repo. It is marked as a Template so you will only have to Use this template and follow the instructions. Read more about this in the GitHub's Template Repositories document.
With Dev Container CLI:
Just run devcontainer up devcontainers-try-docsify in the repo. And that's it. Now you can write more contents and live preview on localhost:3000.
With VS Code:
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.
Known Issues
Learning Resources
- GitHub Learning Lab for GitHub Pages
- Mastering Markdown
- Create GitHub Pages with Docsify
- Creating additional pages and content using Docsify
Awesome Lists are curated lists of awesome stuff. But, what is awesome?
Awesome Docsify | GitHub Cheat Sheet
Feedback
If you have any technical problems with Docsify, you are better off asking Docsify Support directly, since you'll end up getting a much faster response back that way.
Contributing
The official repo to contribute would be @docsifyjs.
License
Copyright (c) Alertbox Inc. All rights reserved.
The source code is license under the MIT License.