A simple Docsify template for creating Markdown-based documentation sites, with no build process required.
This template uses the latest Docsify v5 release candidate (Documentation | Assets via jsDelivr | Release notes), which highlights a modernized UI with improved accessibility and theming, simplified CSS customization and theme add-ons (incl. dark theme support). Other new features include a Google Analytics plugin, enhanced error handling, substantial code cleanup and numerous bug fixes.
Upload these template files to any static web server. The file .nojekyll is only required if hosting the site on GitHub Pages and otherwise can be removed.
To host this template on GitHub Pages do the following:
- Log into GitHub if you have not done so already
- Tap the Use this template button in the upper-right of this GitHub Repository and choose Create a new repository
- Enter a name for your new Repository and then tap the Create repository button
- Once your new Repostitory is created go to Settings, then select Pages from the left-hand sidebar, and under Branch choose main and then tap the Save button
- Wait a minute or two and refresh the same Pages page - once your site is ready a message will be displayed at the top of the screen along with a site link and a Visit site button
How about editing the content of your new Docsify site on GitHub Pages? View the Markdown page you want to edit (for example, README.md) and tap the Pencil Icon, then save any changes by tapping the green Commit changes... button. In just a few moments the Docsify site will be automatically updated to reflect those changes.
Run npx serve . (Node.js users) or python -m http.server 8000 (Python users) in the repo folder to serve run locally.
To learn more about using Docsify v5 preview, visit https://preview.docsifyjs.org.